/**
* clutter_actor_get_preferred_size:
* @self: a #ClutterActor
- * @min_width_p: return location for the minimum width, or %NULL
- * @min_height_p: return location for the minimum height, or %NULL
- * @natural_width_p: return location for the natural width, or %NULL
- * @natural_height_p: return location for the natural height, or %NULL
+ * @min_width_p: (out) (allow-none): return location for the minimum width, or %NULL
+ * @min_height_p: (out) (allow-none): return location for the minimum height, or %NULL
+ * @natural_width_p: (out) (allow-none): return location for the natural width, or %NULL
+ * @natural_height_p: (out) (allow-none): return location for the natural height, or %NULL
*
* Computes the preferred minimum and natural size of an actor, taking into
* account the actor's geometry management (either height-for-width
*
* Retrieves the parent of @self.
*
- * Return Value: The #ClutterActor parent, or %NULL if no parent is set
+ * Return Value: (transfer none): The #ClutterActor parent, or %NULL if no parent is set
*/
ClutterActor *
clutter_actor_get_parent (ClutterActor *self)
/**
* clutter_actor_raise:
* @self: A #ClutterActor
- * @below: A #ClutterActor to raise above.
+ * @below: (allow-none): A #ClutterActor to raise above.
*
* Puts @self above @below.
*
/**
* clutter_actor_lower:
* @self: A #ClutterActor
- * @above: A #ClutterActor to lower below
+ * @above: (allow-none): A #ClutterActor to lower below
*
* Puts @self below @above.
*
/**
* clutter_actor_transform_stage_point
* @self: A #ClutterActor
- * @x: x screen coordinate of the point to unproject, in #ClutterUnit<!-- -->s
- * @y: y screen coordinate of the point to unproject, in #ClutterUnit<!-- -->s
- * @x_out: return location for the unprojected x coordinance, in
+ * @x: (in): x screen coordinate of the point to unproject, in #ClutterUnit<!-- -->s
+ * @y: (in): y screen coordinate of the point to unproject, in #ClutterUnit<!-- -->s
+ * @x_out: (out): return location for the unprojected x coordinance, in
* #ClutterUnit<!-- -->s
- * @y_out: return location for the unprojected y coordinance, in
+ * @y_out: (out): return location for the unprojected y coordinance, in
* #ClutterUnit<!-- -->s
*
* This function translates screen coordinates (@x, @y) to
*
* Queries the currently set #ClutterShader on @self.
*
- * Return value: The currently set #ClutterShader or %NULL if no
+ * Return value: (transfer none): The currently set #ClutterShader or %NULL if no
* shader is set.
*
* Since: 0.6
*
* Retrieves the #ClutterStage where @actor is contained.
*
- * Return value: the stage containing the actor, or %NULL
+ * Return value: (transfer none): the stage containing the actor, or %NULL
*
* Since: 0.8
*/
* and render text using cogl_pango_render_layout() to reuse the
* glyphs cache also used by Clutter.
*
- * Return value: the #PangoContext for a #ClutterActor. The returned
- * #PangoContext is owned by the actor and should not be unreferenced
- * by the application code
+ * Return value: (transfer none): the #PangoContext for a #ClutterActor.
+ * The returned #PangoContext is owned by the actor and should not be
+ * unreferenced by the application code
*
* Since: 1.0
*/
*
* Gets the #ClutterTimeline bound to @alpha.
*
- * Return value: a #ClutterTimeline instance
+ * Return value: (transfer none): a #ClutterTimeline instance
*
* Since: 0.2
*/
* Retrieves the #ClutterInterval associated to @property_name
* inside @animation.
*
- * Return value: a #ClutterInterval or %NULL if no property with
- * the same name was found. The returned interval is owned by
- * the #ClutterAnimation and should not be unreferenced
+ * Return value: (transfer none): a #ClutterInterval or %NULL if no
+ * property with the same name was found. The returned interval is
+ * owned by the #ClutterAnimation and should not be unreferenced
*
* Since: 1.0
*/
*
* Retrieves the #GObject attached to @animation.
*
- * Return value: a #GObject
+ * Return value: (transfer none): a #GObject
*
* Since: 1.0
*/
*
* Retrieves the #ClutterTimeline used by @animation
*
- * Return value: the timeline used by the animation
+ * Return value: (transfer none): the timeline used by the animation
*
* Since: 1.0
*/
*
* Retrieves the #ClutterAlpha used by @animation.
*
- * Return value: the alpha object used by the animation
+ * Return value: (transfer none): the alpha object used by the animation
*
* Since: 1.0
*/
* This function is useful if you want to use an existing #ClutterAlpha
* to animate @actor.
*
- * Return value: a #ClutterAnimation object. The object is owned by the
+ * Return value: (transfer none): a #ClutterAnimation object. The object is owned by the
* #ClutterActor and should not be unreferenced with g_object_unref()
*
* Since: 1.0
* This function is useful if you want to use an existing timeline
* to animate @actor.
*
- * Return value: a #ClutterAnimation object. The object is owned by the
- * #ClutterActor and should not be unreferenced with g_object_unref()
+ * Return value: (transfer none): a #ClutterAnimation object. The object is
+ * owned by the #ClutterActor and should not be unreferenced with
+ * g_object_unref()
*
* Since: 1.0
*/
* as it is complete. To avoid this, you should keep a reference on the
* returned value using g_object_ref().</note>
*
- * Return value: a #ClutterAnimation object. The object is owned by the
- * #ClutterActor and should not be unreferenced with g_object_unref()
+ * Return value: (transfer none): a #ClutterAnimation object. The object is
+ * owned by the #ClutterActor and should not be unreferenced with
+ * g_object_unref()
*
* Since: 1.0
*/
}
/**
- * clutter_get_default_backend:
+ * clutter_get_default_backend1:
*
* Retrieves the default #ClutterBackend used by Clutter. The
* #ClutterBackend holds backend-specific configuration options.
*
- * Return value: the default backend. You should not ref or
- * unref the returned object. Applications should rarely need
- * to use this.
+ * Return value: (transfer none): the default backend. You should
+ * not ref or unref the returned object. Applications should rarely
+ * need to use this.
*
* Since: 0.4
*/
*
* Retrieves the font options for @backend.
*
- * Return value: the font options of the #ClutterBackend
+ * Return value: (transfer none): the font options of the #ClutterBackend
*
* Since: 0.8
*/
*
* Get the current path of the behaviour
*
- * Return value: the path
+ * Return value: (transfer none): the path
*
* Since: 1.0
*/
*
* Gets an actor the behaviour was applied to referenced by index num.
*
- * Return value: A Clutter actor or NULL if @index_ is invalid.
+ * Return value: (transfer none): A Clutter actor or NULL if @index_ is invalid.
*
* Since: 0.2
*/
*
* Retrieves the #ClutterAlpha object bound to @behave.
*
- * Return value: a #ClutterAlpha object, or %NULL if no alpha
+ * Return value: (transfer none): a #ClutterAlpha object, or %NULL if no alpha
* object has been bound to this behaviour.
*
* Since: 0.2
* for derived classes to use this in there alpha notify method but use
* #clutter_behaviour_actors_foreach as it avoids alot of needless allocations.
*
- * Return value: a list of actors. You should free the returned list
- * with g_slist_free() when finished using it.
+ * Return value: (transfer container) (element-type ClutterActor): a list of actors.
+ * You should free the returned list with g_slist_free() when finished using it.
*
* Since: 0.2
*/
* pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance));
* ]|
*
- * Return value: the binding pool for the given class. The returned
- * #ClutterBindingPool is owned by Clutter and should not be freed
- * directly
+ * Return value: (transfer none): the binding pool for the given class.
+ * The returned #ClutterBindingPool is owned by Clutter and should not
+ * be freed directly
*
* Since: 1.0
*/
*
* Finds the #ClutterBindingPool with @name.
*
- * Return value: a pointer to the #ClutterBindingPool, or %NULL
+ * Return value: (transfer none): a pointer to the #ClutterBindingPool, or %NULL
*
* Since: 1.0
*/
*
* Retrieves the container using @data
*
- * Return value: a #ClutterContainer
+ * Return value: (transfer none): a #ClutterContainer
*
* Since: 0.8
*/
*
* Retrieves the actor wrapped by @data
*
- * Return value: a #ClutterActor
+ * Return value: (transfer none): a #ClutterActor
*
* Since: 0.8
*/
*
* Retrieves the source #ClutterActor being cloned by @clone
*
- * Return value: the actor source for the clone
+ * Return value: (transfer none): the actor source for the clone
*
* Since: 1.0
*/
* clutter_color_add:
* @src1: a #ClutterColor
* @src2: a #ClutterColor
- * @dest: return location for the result
+ * @dest: (out): return location for the result
*
* Adds @src2 to @src1 and saves the resulting color
* inside @dest.
* clutter_color_subtract:
* @src1: a #ClutterColor
* @src2: a #ClutterColor
- * @dest: return location for the result
+ * @dest: (out): return location for the result
*
* Subtracts @src2 from @src1 and saves the resulting
* color inside @dest. This function assumes that the components
/**
* clutter_color_lighten:
* @src: a #ClutterColor
- * @dest: return location for the lighter color
+ * @dest: (out): return location for the lighter color
*
* Lightens @src by a fixed amount, and saves the changed
* color in @dest.
/**
* clutter_color_darken:
* @src: a #ClutterColor
- * @dest: return location for the darker color
+ * @dest: (out): return location for the darker color
*
* Darkens @src by a fixed amount, and saves the changed color
* in @dest.
/**
* clutter_color_from_hlsx:
- * @dest: return location for a #ClutterColor
+ * @dest: (out): return location for a #ClutterColor
* @hue: hue value (0 .. 360)
* @luminance: luminance value (0 .. 1)
* @saturation: saturation value (0 .. 1)
/**
* clutter_color_from_hls:
- * @dest: return location for a #ClutterColor
+ * @dest: (out): return location for a #ClutterColor
* @hue: hue value (0 .. 255)
* @luminance: luminance value (0 .. 255)
* @saturation: saturation value (0 .. 255)
/**
* clutter_color_shade:
* @src: a #ClutterColor
- * @dest: return location for the shaded color
+ * @dest: (out): return location for the shaded color
* @shade: the shade factor to apply
*
* Shades @src by the factor of @shade and saves the modified
/**
* clutter_color_shadex:
* @src: a #ClutterColor
- * @dest: return location for the shaded color
+ * @dest: (out): return location for the shaded color
* @shade: #ClutterFixed the shade factor to apply
*
* Fixed point version of clutter_color_shade().
/**
* clutter_color_from_pixel:
- * @dest: return location for a #ClutterColor
+ * @dest: (out): return location for a #ClutterColor
* @pixel: a 32 bit packed integer containing a color
*
* Converts @pixel from the packed representation of a four 8 bit channel
/**
* clutter_color_parse:
* @color: a string specifiying a color (named color or #RRGGBBAA)
- * @dest: return location for a #ClutterColor
+ * @dest: (out): return location for a #ClutterColor
*
* Parses a string definition of a color, filling the
* <structfield>red</structfield>, <structfield>green</structfield>,
*
* Retrieves all the children of @container.
*
- * Return value: a list of #ClutterActor<!-- -->s. Use g_list_free()
- * on the returned list when done.
+ * Return value: (element-type Actor) (transfer container): a list
+ * of #ClutterActor<!-- -->s. Use g_list_free() on the returned
+ * list when done.
*
* Since: 0.4
*/
* Finds a child actor of a container by its name. Search recurses
* into any child container.
*
- * Return value: The child actor with the requested name, or %NULL if no
- * actor with that name was found.
+ * Return value: (transfer none): The child actor with the requested name,
+ * or %NULL if no actor with that name was found.
*
* Since: 0.6
*/
* Retrieves the #ClutterChildMeta which contains the data about the
* @container specific state for @actor.
*
- * Return value: the #ClutterChildMeta for the @actor child of @container
- * or %NULL if the specifiec actor does not exist or the container is not
- * configured to provide #ClutterChildMeta<!-- -->s
+ * Return value: (transfer none): the #ClutterChildMeta for the @actor child
+ * of @container or %NULL if the specifiec actor does not exist or the
+ * container is not configured to provide #ClutterChildMeta<!-- -->s
*
* Since: 0.8
*/
*
* Looks up the #GParamSpec for a child property of @klass.
*
- * Return value: The #GParamSpec for the property or %NULL if no such
- * property exist.
+ * Return value: (transfer none): The #GParamSpec for the property or %NULL
+ * if no such property exist.
*
* Since: 0.8
*/
*
* Returns an array of #GParamSpec for all child properties.
*
- * Return value: an array of #GParamSpec<!-- -->s which should be freed
- * after use.
+ * Return value: (array length=n_properties) (transfer container): an array
+ * of #GParamSpec<!-- -->s which should be freed after use.
*
* Since: 0.8
*/
* Retrieves the source #ClutterActor the event originated from, or
* NULL if the event has no source.
*
- * Return value: a #ClutterActor
+ * Return value: (transfer none): a #ClutterActor
*
* Since: 0.6
*/
* Retrieves the source #ClutterStage the event originated for, or
* NULL if the event has no stage.
*
- * Return value: a #ClutterStage
+ * Return value: (transfer none): a #ClutterStage
*
* Since: 0.8
*/
* Returns a pointer to the first event from the event queue but
* does not remove it.
*
- * Return value: A #ClutterEvent or NULL if queue empty.
+ * Return value: (transfer none): A #ClutterEvent or NULL if queue empty.
*
* Since: 0.4
*/
*
* Gets a groups child held at @index_ in stack.
*
- * Return value: A Clutter actor or NULL if @index_ is invalid.
+ * Return value: (transfer none): A Clutter actor or NULL if @index_ is invalid.
*
* Since: 0.2
**/
*
* Gets the pointer to the initial value of @interval
*
- * Return value: the initial value of the interval. The value
- * is owned by the #ClutterInterval and it should not be
+ * Return value: (transfer none): the initial value of the interval.
+ * The value is owned by the #ClutterInterval and it should not be
* modified or freed
*
* Since: 1.0
*
* Gets the pointer to the final value of @interval
*
- * Return value: the final value of the interval. The value
- * is owned by the #ClutterInterval and it should not be
+ * Return value: (transfer none): the final value of the interval.
+ * The value is owned by the #ClutterInterval and it should not be
* modified or freed
*
* Since: 1.0
* Clutter #GOptionGroup has returned %TRUE, Clutter is guaranteed to be
* initialized.
*
- * Return value: a #GOptionGroup for the commandline arguments
+ * Return value: (transfer full): a #GOptionGroup for the commandline arguments
* recognized by Clutter
*
* Since: 0.2
* function when needing to set foreign display connection with
* clutter_x11_set_display(), or with gtk_clutter_init().
*
- * Return value: a #GOptionGroup for the commandline arguments
+ * Return value: (transfer full): a #GOptionGroup for the commandline arguments
* recognized by Clutter
*
* Since: 0.8.2
return group;
}
+/* Note that the gobject-introspection annotations for the argc/argv
+ * parameters do not produce the right result; however, they do
+ * allow the common case of argc=NULL, argv=NULL to work.
+ */
+
/**
* clutter_init_with_args:
- * @argc: a pointer to the number of command line arguments
- * @argv: a pointer to the array of command line arguments
+ * @argc: (inout): a pointer to the number of command line arguments
+ * @argv: (array length=argc) (inout): a pointer to the array of command line arguments
* @parameter_string: a string which is displayed in the
* first line of <option>--help</option> output, after
* <literal><replaceable>programname</replaceable> [OPTION...]</literal>
/**
* clutter_init:
- * @argc: The number of arguments in @argv
- * @argv: A pointer to an array of arguments.
+ * @argc: (inout): The number of arguments in @argv
+ * @argv: (array length=argc) (inout): A pointer to an array of arguments.
*
* It will initialise everything needed to operate with Clutter and
* parses some standard command line options. @argc and @argv are
*
* Retrieves the #ClutterActor with @id.
*
- * Return value: the actor with the passed id or %NULL. The returned
- * actor does not have its reference count increased.
+ * Return value: (transfer none): the actor with the passed id or %NULL.
+ * The returned actor does not have its reference count increased.
*
* Since: 0.6
*/
*
* Queries the current pointer grab of clutter.
*
- * Return value: the actor currently holding the pointer grab, or NULL if there is no grab.
+ * Return value: (transfer none): the actor currently holding the pointer grab, or NULL if there is no grab.
*
* Since: 0.6
*/
*
* Queries the current keyboard grab of clutter.
*
- * Return value: the actor currently holding the keyboard grab, or NULL if there is no grab.
+ * Return value: (transfer none): the actor currently holding the keyboard grab, or NULL if there is no grab.
*
* Since: 0.6
*/
*
* Retrieves the #ClutterInputDevice from its id.
*
- * Return value: a #ClutterInputDevice, or %NULL
+ * Return value: (transfer none): a #ClutterInputDevice, or %NULL
*
* Since: 0.8
*/
* You can use the global font map object with the COGL
* Pango API.
*
- * Return value: the #PangoFontMap instance. The returned
- * value is owned by Clutter and it should never be
- * unreferenced.
+ * Return value: (transfer none): the #PangoFontMap instance. The returned
+ * value is owned by Clutter and it should never be unreferenced.
*
* Since: 1.0
*/
* clutter_model_set_types:
* @model: a #ClutterModel
* @n_columns: number of columns for the model
- * @types: an array of #GType types
+ * @types: (array length=n_columns): an array of #GType types
*
* Sets the types of the columns inside a #ClutterModel.
*
* clutter_model_set_names:
* @model: a #ClutterModel
* @n_columns: the number of column names
- * @names: an array of strings
+ * @names: (array length=n_columns): an array of strings
*
* Assigns a name to the columns of a #ClutterModel.
*
* clutter_model_appendv:
* @model: a #ClutterModel
* @n_columns: the number of columns and values
- * @columns: a vector with the columns to set
- * @values: a vector with the values
+ * @columns: (array length=n_columns): a vector with the columns to set
+ * @values: (array length=n_columns): a vector with the values
*
* Creates and appends a new row to the #ClutterModel, setting the row
* values for the given @columns upon creation.
* clutter_model_prependv:
* @model: a #ClutterModel
* @n_columns: the number of columns and values to set
- * @columns: a vector containing the columns to set
- * @values: a vector containing the values for the cells
+ * @columns: (array length=n_columns): a vector containing the columns to set
+ * @values: (array length=n_columns): a vector containing the values for the cells
*
* Creates and prepends a new row to the #ClutterModel, setting the row
* values for the given @columns upon creation.
* @model: a #ClutterModel
* @row: row index
* @n_columns: the number of columns and values to set
- * @columns: a vector containing the columns to set
- * @values: a vector containing the values for the cells
+ * @columns: (array length=n_columns): a vector containing the columns to set
+ * @values: (array length=n_columns): a vector containing the values for the cells
*
* Inserts data at @row into the #ClutterModel, setting the row
* values for the given @columns upon creation.
*
* Retrieves a #ClutterModelIter representing the row at the given index.
*
- * Return value: A new #ClutterModelIter, or %NULL if @row was out of bounds.
- * When done using the iterator object, call g_object_unref() to deallocate
- * its resources
+ * Return value: (transfer full): A new #ClutterModelIter, or %NULL if @row was
+ * out of bounds. When done using the iterator object, call g_object_unref()
+ * to deallocate its resources
*
* Since: 0.6
*/
*
* Retrieves a #ClutterModelIter representing the first row in @model.
*
- * Return value: A new #ClutterModelIter. Call g_object_unref() when
+ * Return value: (transfer full): A new #ClutterModelIter. Call g_object_unref() when
* done using it
*
* Since: 0.6
*
* Retrieves a #ClutterModelIter representing the last row in @model.
*
- * Return value: A new #ClutterModelIter. Call g_object_unref() when
+ * Return value: (transfer full): A new #ClutterModelIter. Call g_object_unref() when
* done using it
*
* Since: 0.6
* The model implementation should take into account the presence of
* a filter function.
*
- * Return value: The passed iterator, updated to point at the next
+ * Return value: (transfer none): The passed iterator, updated to point at the next
* row in the model.
*
* Since: 0.6
* The model implementation should take into account the presence of
* a filter function.
*
- * Return value: The passed iterator, updated to point at the previous
+ * Return value: (transfer none): The passed iterator, updated to point at the previous
* row in the model.
*
* Since: 0.6
*
* Retrieves a pointer to the #ClutterModel that this iter is part of.
*
- * Return value: a pointer to a #ClutterModel.
+ * Return value: (transfer none): a pointer to a #ClutterModel.
*
* Since: 0.6
*/
* list to become invalid so you should copy them if you want to keep
* the list.
*
- * Return value: a list of nodes in the path.
+ * Return value: (transfer container) (element-type ClutterPathNode): a list of nodes in the path.
*
* Since: 1.0
*/
*
* Retrieves the #ClutterTimeline for @id inside @score.
*
- * Return value: the requested timeline, or %NULL. This function does
- * not increase the reference count on the returned #ClutterTimeline
+ * Return value: (transfer none): the requested timeline, or %NULL. This
+ * function does not increase the reference count on the returned
+ * #ClutterTimeline
*
* Since: 0.6
*/
*
* Retrieves a list of all the #ClutterTimelines managed by @score.
*
- * Return value: a #GSList containing all the timelines in the score.
- * This function does not increase the reference count of the
- * returned timelines. Use g_slist_free() on the returned list to
- * deallocate its resources.
+ * Return value: (transfer container) (element-type ClutterTimeline): a #GSList
+ * containing all the timelines in the score. This function does not increase
+ * the reference count of the returned timelines. Use g_slist_free() on the
+ * returned list to deallocate its resources.
*
* Since: 0.6
*/
* Retrieves the object bound to @name. This function does not increment
* the reference count of the returned object.
*
- * Return value: the named object, or %NULL if no object with the
- * given name was available
+ * Return value: : (transfer none): the named object, or %NULL if no object
+ * with the given name was available
*
* Since: 0.6
*/
* Note: this function does not increment the reference count of the
* objects it returns.
*
- * Return value: a list of #GObject<!-- -->s, or %NULL. The objects are
- * owned by the #ClutterScript instance. Use g_list_free() on the
+ * Return value: (transfer container) (element-type GObject): a list of #GObject<!-- -->s,
+ * or %NULL. The objects are owned by the #ClutterScript instance. Use g_list_free() on the
* returned value when done.
*
* Since: 0.8.2
/**
* clutter_value_get_shader_matrix:
* @value: a #GValue
- * @length: return location for the number of returned floating
+ * @length: (out): return location for the number of returned floating
* point values, or %NULL
*
* Retrieves a matrix of floating point values stored inside
* the passed #GValue. @value must have been initialized with
* %CLUTTER_TYPE_SHADER_MATRIX.
*
- * Return value: the pointer to a matrix of floating point values.
- * The returned value is owned by the #GValue and should never
- * be modified or freed.
+ * Return value: (array length=length) (transfer none): the pointer to a matrix
+ * of floating point values. The returned value is owned by the #GValue and
+ * should never be modified or freed.
*
* Since: 0.8
*/
*
* Returns the default #ClutterStageManager.
*
- * Return value: the default stage manager instance. The returned object
- * is owned by Clutter and you should not reference or unreference it.
+ * Return value: (transfer none): the default stage manager instance. The returned
+ * object is owned by Clutter and you should not reference or unreference it.
*
* Since: 0.8
*/
*
* Returns the default #ClutterStage.
*
- * Return value: the default stage. The returned object is owned by
- * Clutter and you should never reference or unreference it
+ * Return value: (transfer none): the default stage. The returned object
+ * is owned by Clutter and you should never reference or unreference it
*
* Since: 0.8
*/
*
* Lists all currently used stages.
*
- * Return value: a newly allocated list of #ClutterStage objects. Use
- * g_slist_free() to deallocate it when done.
+ * Return value: (transfer container) (element-type ClutterStage): a newly allocated list
+ * of #ClutterStage objects. Use g_slist_free() to deallocate it when done.
*
* Since: 0.8
*/
*
* Clutter guarantess the existence of the default stage.
*
- * Return value: the main #ClutterStage. You should never
+ * Return value: (transfer none): the main #ClutterStage. You should never
* destroy or unref the returned actor.
*/
ClutterActor *
* Checks the scene at the coordinates @x and @y and returns a pointer
* to the #ClutterActor at those coordinates.
*
- * Return value: the actor at the specified coordinates, if any
+ * Return value: (transfer none): the actor at the specified coordinates, if any
*/
ClutterActor *
clutter_stage_get_actor_at_pos (ClutterStage *stage,
*
* Retrieves the actor that is currently under key focus.
*
- * Return value: the actor with key focus, or the stage
+ * Return value: (transfer none): the actor with key focus, or the stage
*
* Since: 0.6
*/
*
* Retrieves the current #PangoLayout used by a #ClutterText actor.
*
- * Return value: a #PangoLayout. The returned object is owned by
+ * Return value: (transfer none): a #PangoLayout. The returned object is owned by
* the #ClutterText actor and should not be modified or freed
*
* Since: 1.0
* Gets the attribute list that was set on the #ClutterText actor
* clutter_text_set_attributes(), if any.
*
- * Return value: the attribute list, or %NULL if none was set. The
- * returned value is owned by the #ClutterText and should not be
- * unreferenced.
+ * Return value: (transfer none): the attribute list, or %NULL if none was set. The
+ * returned value is owned by the #ClutterText and should not be unreferenced.
*
* Since: 1.0
*/
* negative integer, all the markers attached to @timeline will be
* returned.
*
- * Return value: a newly allocated, %NULL terminated string array
- * containing the names of the markers. Use g_strfreev() when
- * done.
+ * Return value: (array zero-terminated=1 length=n_markers): a newly
+ * allocated, %NULL terminated string array containing the names of
+ * the markers. Use g_strfreev() when done.
*
* Since: 0.8
*/
*
* Gets the elements of a #JsonArray as a list of #JsonNode<!-- -->s.
*
- * Return value: a #GList containing the elements of the array. The
- * contents of the list are owned by the array and should never be
- * modified or freed. Use g_list_free() on the returned list when
+ * Return value: (transfer container) (element-type JsonNode): a #GList containing
+ * the elements of the array. The contents of the list are owned by the array and
+ * should never be modified or freed. Use g_list_free() on the returned list when
* done using it
*/
GList *
* Retrieves the #JsonNode containing the value of the element at @index_
* inside a #JsonArray.
*
- * Return value: a pointer to the #JsonNode at the requested index
+ * Return value: (transfer none): a pointer to the #JsonNode at the requested index
*/
JsonNode *
json_array_get_element (JsonArray *array,
*
* Retrieves the #JsonObject stored inside a #JsonNode
*
- * Return value: the #JsonObject
+ * Return value: (transfer none): the #JsonObject
*/
JsonObject *
json_node_get_object (JsonNode *node)
*
* Retrieves the #JsonArray stored inside a #JsonNode
*
- * Return value: the #JsonArray
+ * Return value: (transfer none): the #JsonArray
*/
JsonArray *
json_node_get_array (JsonNode *node)
*
* Retrieves the parent #JsonNode of @node.
*
- * Return value: the parent node, or %NULL if @node is the root node
+ * Return value: (transfer none): the parent node, or %NULL if @node is the root node
*/
JsonNode *
json_node_get_parent (JsonNode *node)
* Retrieves all the names of the members of a #JsonObject. You can
* obtain the value for each member using json_object_get_member().
*
- * Return value: a #GList of member names. The content of the list
- * is owned by the #JsonObject and should never be modified or
- * freed. When you have finished using the returned list, use
- * g_list_free() to free the resources it has allocated.
+ * Return value: (transfer container) (element-type utf8): a #GList of
+ * member names. The content of the list is owned by the #JsonObject
+ * and should never be modified or freed. When you have finished using
+ * the returned list, use g_list_free() to free the resources it has
+ * allocated.
*/
GList *
json_object_get_members (JsonObject *object)
* Retrieves the #JsonNode containing the value of @member_name inside
* a #JsonObject.
*
- * Return value: a pointer to the node for the requested object
+ * Return value: (transfer none): a pointer to the node for the requested object
* member, or %NULL
*/
JsonNode *
*
* Retrieves the top level node from the parsed JSON stream.
*
- * Return value: the root #JsonNode . The returned node is owned by
- * the #JsonParser and should never be modified or freed.
+ * Return value: (transfer none): the root #JsonNode . The returned node
+ * is owned by the #JsonParser and should never be modified or freed.
*/
JsonNode *
json_parser_get_root (JsonParser *parser)
projects / profile / ivi / clutter.git / commitdiff