gboolean (* get_enabled) (GAction *action);
GVariant * (* get_state) (GAction *action);
void (* set_state) (GAction *action,
- GVariant *state);
+ GVariant *value);
void (* activate) (GAction *action,
GVariant *parameter);
* On some platforms, there may be a difference between user-defined
* #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
* cannot. See g_app_info_can_delete().
- *
+ *
+ * Virtual: do_delete
* Returns: %TRUE if @appinfo has been deleted
*
* Since: 2.20
*
* Gets the user data from a #GAsyncResult.
*
- * Returns: the user data for @res.
+ * Returns: (transfer full): the user data for @res.
**/
gpointer
g_async_result_get_user_data (GAsyncResult *res)
*
* Gets the source object from a #GAsyncResult.
*
- * Returns: a new reference to the source object for the @res,
+ * Returns: (transfer full): a new reference to the source object for the @res,
* or %NULL if there is none.
*/
GObject *
*
* Gets the top cancellable from the stack.
*
- * Returns: a #GCancellable from the top of the stack, or %NULL
+ * Returns: (transfer none): a #GCancellable from the top of the stack, or %NULL
* if the stack is empty.
**/
GCancellable *
*
* Gets the icon for a content type.
*
- * Returns: #GIcon corresponding to the content type. Free the returned
+ * Returns: (transfer full): #GIcon corresponding to the content type. Free the returned
* object with g_object_unref()
*/
GIcon *
* This function is useful in the implementation of
* g_mount_guess_content_type().
*
- * Returns: an %NULL-terminated array of zero or more content types,
+ * Returns: (transfer full): an %NULL-terminated array of zero or more content types,
* or %NULL. Free with g_strfreev()
*
* Since: 2.18
*
* Gets the #GConverter that is used by @converter_stream.
*
- * Returns: the converter of the converter input stream
+ * Returns: (transfer none): the converter of the converter input stream
*
* Since: 2.24
*/
*
* Gets the #GConverter that is used by @converter_stream.
*
- * Returns: the converter of the converter output stream
+ * Returns: (transfer none): the converter of the converter output stream
*
* Since: 2.24
*/
}
/**
- * g_credentials_get_native:
+ * g_credentials_get_native: (skip)
* @credentials: A #GCredentials.
* @native_type: The type of native credentials to get.
*
*
* Finishes an operation started with g_dbus_address_get_stream().
*
- * Returns: A #GIOStream or %NULL if @error is set.
+ * Returns: (transfer full): A #GIOStream or %NULL if @error is set.
*
* Since: 2.26
*/
* This is a synchronous failable function. See
* g_dbus_address_get_stream() for the asynchronous version.
*
- * Returns: A #GIOStream or %NULL if @error is set.
+ * Returns: (transfer full): A #GIOStream or %NULL if @error is set.
*
* Since: 2.26
*/
*
* Gets the underlying stream used for IO.
*
- * Returns: the stream used for IO
+ * Returns: (transfer none): the stream used for IO
*
* Since: 2.26
*/
* linkend="gdbus-unix-fd-client"/> for an example of how to use this
* low-level API to send and receive UNIX file descriptors.
*
- * Returns: A locked #GDBusMessage or %NULL if @error is set.
+ * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set.
*
* Since: 2.26
*/
* Note that @message must be unlocked, unless @flags contain the
* %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
*
- * Returns: A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
+ * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
*
* Since: 2.26
*/
* each application is a client. So this method will always return
* %NULL for message bus clients.
*
- * Returns: A #GCredentials or %NULL if not available. Do not free
+ * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free
* this object, it is owned by @connection.
*
* Since: 2.26
* Note that the returned #GDBusConnection object will (usually) have
* the #GDBusConnection:exit-on-close property set to %TRUE.
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
*
* Since: 2.26
*/
* Note that the returned #GDBusConnection object will (usually) have
* the #GDBusConnection:exit-on-close property set to %TRUE.
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
*
* Since: 2.26
*/
*
* Creates a new #GDBusMessage that is a reply to @method_call_message.
*
- * Returns: A #GDBusMessage. Free with g_object_unref().
+ * Returns: (transfer full): #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/
*
* Creates a new #GDBusMessage that is an error reply to @method_call_message.
*
- * Returns: A #GDBusMessage. Free with g_object_unref().
+ * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/
*
* Creates a new #GDBusMessage that is an error reply to @method_call_message.
*
- * Returns: A #GDBusMessage. Free with g_object_unref().
+ * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/
*
* Like g_dbus_message_new_method_error() but intended for language bindings.
*
- * Returns: A #GDBusMessage. Free with g_object_unref().
+ * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
*
* Since: 2.26
*/
*
* This method is only available on UNIX.
*
- * Returns: A #GUnixFDList or %NULL if no file descriptors are
+ * Returns: (transfer none):A #GUnixFDList or %NULL if no file descriptors are
* associated. Do not free, this object is owned by @message.
*
* Since: 2.26
* This operation can fail if e.g. @message contains file descriptors
* and the per-process or system-wide open files limit is reached.
*
- * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
+ * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set. Free with
* g_object_unref().
*
* Since: 2.26
*
* Gets the #GDBusConnection the method was invoked on.
*
- * Returns: A #GDBusConnection. Do not free, it is owned by @invocation.
+ * Returns: (transfer none):A #GDBusConnection. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/
* linkend="gdbus-unix-fd-client"/> for an example of how to use this
* low-level API to send and receive UNIX file descriptors.
*
- * Returns: A #GDBusMessage. Do not free, it is owned by @invocation.
+ * Returns: (transfer none): #GDBusMessage. Do not free, it is owned by @invocation.
*
* Since: 2.26
*/
}
/**
- * g_dbus_method_invocation_get_user_data:
+ * g_dbus_method_invocation_get_user_data: (skip)
* @invocation: A #GDBusMethodInvocation.
*
* Gets the @user_data #gpointer passed to g_dbus_connection_register_object().
*
* Gets the connection @proxy is for.
*
- * Returns: A #GDBusConnection owned by @proxy. Do not free.
+ * Returns: (transfer none): A #GDBusConnection owned by @proxy. Do not free.
*
* Since: 2.26
*/
* in a GIO module. There is no reason for applications to use it
* directly. Applications should use g_app_info_get_default_for_uri_scheme().
*
- * Returns: #GAppInfo for given @uri_scheme or %NULL on error.
+ * Returns: (transfer full): #GAppInfo for given @uri_scheme or %NULL on error.
*/
GAppInfo *
g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
*
* Gets the icon for @drive.
*
- * Returns: #GIcon for the @drive.
+ * Returns: (transfer full): #GIcon for the @drive.
* Free the returned object with g_object_unref().
**/
GIcon *
* Use g_drive_get_identifer() to obtain the identifiers
* themselves.
*
- * Returns: a %NULL-terminated array of strings containing
+ * Returns: (transfer full): a %NULL-terminated array of strings containing
* kinds of identifiers. Use g_strfreev() to free.
*/
char **
*
* Gives back the icon from @emblem.
*
- * Returns: a #GIcon. The returned object belongs to the emblem
+ * Returns: (transfer full): a #GIcon. The returned object belongs to the emblem
* and should not be modified or freed.
*
* Since: 2.18
*
* Creates a new emblemed icon for @icon with the emblem @emblem.
*
- * Returns: a new #GIcon
+ * Returns: (transfer full): a new #GIcon
*
* Since: 2.18
**/
*
* Gets the main icon for @emblemed.
*
- * Returns: a #GIcon that is owned by @emblemed
+ * Returns: (transfer full): a #GIcon that is owned by @emblemed
*
* Since: 2.18
**/
* Creates a hash value for a #GFile.
*
* This call does no blocking i/o.
- *
+ *
+ * Virtual: hash
* Returns: 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
*
* This call does no blocking i/o.
*
- * Returns: a #GFile structure to the parent of the given
+ * Returns: (transfer full): 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().
**/
* filesystem point of view), because the prefix of @file is an alias
* of @prefix.
*
+ * Virtual: prefix_matches
* Returns: %TRUE if the @files's parent, grandparent, etc is @prefix.
* %FALSE otherwise.
**/
*
* This call does no blocking i/o.
*
- * Returns: #GFile to the resolved path. %NULL if @relative_path
+ * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path
* is %NULL or if @file is invalid.
* Free the returned object with g_object_unref().
**/
* If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
- * Returns: a #GFileInfo for the given @file, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileInfo *
* Finishes an asynchronous file info query.
* See g_file_query_info_async().
*
- * Returns: #GFileInfo for given @file or %NULL on error.
+ * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileInfo *
* If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
- * Returns: a #GFileInfo or %NULL if there was an error.
+ * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
* Free the returned object with g_object_unref().
**/
GFileInfo *
* Finishes an asynchronous filesystem info query. See
* g_file_query_filesystem_info_async().
*
- * Returns: #GFileInfo for given @file or %NULL on error.
+ * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileInfo *
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a #GMount where the @file is located or %NULL on error.
+ * Returns: (transfer full): a #GMount where the @file is located or %NULL on error.
* Free the returned object with g_object_unref().
**/
GMount *
* Finishes an asynchronous find mount request.
* See g_file_find_enclosing_mount_async().
*
- * Returns: #GMount for given @file or %NULL on error.
+ * Returns: (transfer full): #GMount for given @file or %NULL on error.
* Free the returned object with g_object_unref().
**/
GMount *
* If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
- * Returns: #GFileInputStream or %NULL on error.
+ * Virtual: read_fn
+ * Returns: (transfer full): #GFileInputStream or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileInputStream *
* returned. Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
- * Returns: a #GFileOutputStream, or %NULL on error.
+ * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileOutputStream *
* Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
- * Returns: a #GFileOutputStream for the newly created file, or
+ * Returns: (transfer full): a #GFileOutputStream for the newly created file, or
* %NULL on error.
* Free the returned object with g_object_unref().
**/
* Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
- * Returns: a #GFileOutputStream or %NULL on error.
+ * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileOutputStream *
* so make sure you really need to do read and write streaming, rather than
* just opening for reading or writing.
*
- * Returns: #GFileIOStream or %NULL on error.
+ * Returns: (transfer full): #GFileIOStream or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* supported, so make sure you really need to do read and write streaming,
* rather than just opening for reading or writing.
*
- * Returns: a #GFileIOStream for the newly created file, or %NULL on error.
+ * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* supported, so make sure you really need to do read and write streaming,
* rather than just opening for reading or writing.
*
- * Returns: a #GFileIOStream or %NULL on error.
+ * Returns: (transfer full): a #GFileIOStream or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* Finishes an asynchronous file read operation started with
* g_file_read_async().
*
- * Returns: a #GFileInputStream or %NULL on error.
+ * Returns: (transfer full): a #GFileInputStream or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileInputStream *
* Finishes an asynchronous file append operation started with
* g_file_append_to_async().
*
- * Returns: a valid #GFileOutputStream or %NULL on error.
+ * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileOutputStream *
* Finishes an asynchronous file create operation started with
* g_file_create_async().
*
- * Returns: a #GFileOutputStream or %NULL on error.
+ * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileOutputStream *
* Finishes an asynchronous file replace operation started with
* g_file_replace_async().
*
- * Returns: a #GFileOutputStream, or %NULL on error.
+ * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileOutputStream *
* Finishes an asynchronous file read operation started with
* g_file_open_readwrite_async().
*
- * Returns: a #GFileIOStream or %NULL on error.
+ * Returns: (transfer full): a #GFileIOStream or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* Finishes an asynchronous file create operation started with
* g_file_create_readwrite_async().
*
- * Returns: a #GFileIOStream or %NULL on error.
+ * Returns: (transfer full): a #GFileIOStream or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* Finishes an asynchronous file replace operation started with
* g_file_replace_readwrite_async().
*
- * Returns: a #GFileIOStream, or %NULL on error.
+ * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* 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.
- *
+ *
+ * Virtual: delete_file
* Returns: %TRUE if the file was deleted. %FALSE otherwise.
**/
gboolean
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a #GFile specifying what @file was renamed to, or %NULL
+ * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL
* if there was an error.
* Free the returned object with g_object_unref().
**/
* Finishes setting a display name started with
* g_file_set_display_name_async().
*
- * Returns: a #GFile or %NULL on error.
+ * Returns: (transfer full): a #GFile or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFile *
* Finish an asynchronous mount operation that was started
* with g_file_mount_mountable().
*
- * Returns: a #GFile or %NULL on error.
+ * Returns: (transfer full): a #GFile or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFile *
* 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.
- *
- * Returns: a #GFileMonitor for the given @file, or %NULL on error.
+ *
+ * Virtual: monitor_dir
+ * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
* Free the returned object with g_object_unref().
**/
GFileMonitor*
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a #GFileMonitor for the given @file, or %NULL on error.
+ * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.18
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a #GAppInfo if the handle was found, %NULL if there were errors.
+ * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors.
* When you are done with it, release it with g_object_unref()
**/
GAppInfo *
*
* Finishes the asynchronous operation started with g_file_enumerator_next_files_async().
*
- * Returns: (transfer full) (element-type FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with
+ * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with
* g_list_free() and unref the infos with g_object_unref() when you're
* done with them.
**/
*
* Creates a new icon for a file.
*
- * Returns: a #GIcon for the given @file, or %NULL on error.
+ * Returns: (transfer full): a #GIcon for the given @file, or %NULL on error.
**/
GIcon *
g_file_icon_new (GFile *file)
*
* Gets the #GFile associated with the given @icon.
*
- * Returns: a #GFile, or %NULL.
+ * Returns: (transfer none): a #GFile, or %NULL.
**/
GFile *
g_file_icon_get_file (GFileIcon *icon)
*
* Duplicates a file info structure.
*
- * Returns: a duplicate #GFileInfo of @other.
+ * Returns: (transfer full): a duplicate #GFileInfo of @other.
**/
GFileInfo *
g_file_info_dup (GFileInfo *other)
* Gets the value of a stringv attribute. If the attribute does
* not contain a stringv, %NULL will be returned.
*
- * Returns: the contents of the @attribute value as a stringv, or
+ * Returns: (transfer none): the contents of the @attribute value as a stringv, or
* %NULL otherwise. Do not free.
*
* Since: 2.22
* stream is blocked, the stream will set the pending flag internally, and
* any other operations on the stream will fail with %G_IO_ERROR_PENDING.
*
- * Returns: a #GFileInfo, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo, or %NULL on error.
**/
GFileInfo *
g_file_input_stream_query_info (GFileInputStream *stream,
*
* Finishes an asynchronous info query operation.
*
- * Returns: #GFileInfo.
+ * Returns: (transfer full): #GFileInfo.
**/
GFileInfo *
g_file_input_stream_query_info_finish (GFileInputStream *stream,
* was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
* be returned.
*
- * Returns: a #GFileInfo for the @stream, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
*
* Since: 2.22
**/
* Finalizes the asynchronous query started
* by g_file_io_stream_query_info_async().
*
- * Returns: A #GFileInfo for the finished query.
+ * Returns: (transfer full): A #GFileInfo for the finished query.
*
* Since: 2.22
**/
* was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
* be returned.
*
- * Returns: a #GFileInfo for the @stream, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
**/
GFileInfo *
g_file_output_stream_query_info (GFileOutputStream *stream,
* Finalizes the asynchronous query started
* by g_file_output_stream_query_info_async().
*
- * Returns: A #GFileInfo for the finished query.
+ * Returns: (transfer full): A #GFileInfo for the finished query.
**/
GFileInfo *
g_file_output_stream_query_info_finish (GFileOutputStream *stream,
* @icon: #gconstpointer to an icon object.
*
* Gets a hash for an icon.
- *
+ *
+ * Virtual: hash
* Returns: a #guint containing a hash for the @icon, suitable for
* use in a #GHashTable or similar data structure.
**/
* </para></listitem>
* </itemizedlist>
*
+ * Virtual: to_tokens
* Returns: An allocated NUL-terminated UTF8 string or %NULL if @icon can't
* be serialized. Use g_free() to free.
*
*
* Gets @address's #GInetAddress.
*
- * Returns: the #GInetAddress for @address, which must be
+ * Returns: (transfer full): the #GInetAddress for @address, which must be
* g_object_ref()'d if it will be stored
*
* Since: 2.22
* similar to g_object_new() but also initializes the object
* and returns %NULL, setting an error on failure.
*
- * Return value: a newly allocated #GObject, or %NULL on error
+ * Return value: (transfer full): a newly allocated #GObject, or %NULL on error
*
* Since: 2.22
*/
* similar to g_object_newv() but also initializes the object
* and returns %NULL, setting an error on failure.
*
- * Return value: a newly allocated #GObject, or %NULL on error
+ * Return value: (transfer full): a newly allocated #GObject, or %NULL on error
*
* Since: 2.22
*/
* similar to g_object_new_valist() but also initializes the object
* and returns %NULL, setting an error on failure.
*
- * Return value: a newly allocated #GObject, or %NULL on error
+ * Return value: (transfer full): a newly allocated #GObject, or %NULL on error
*
* Since: 2.22
*/
*
* Finds a #GIOExtension for an extension point by name.
*
- * Returns: the #GIOExtension for @extension_point that has the
+ * Returns: (transfer none): the #GIOExtension for @extension_point that has the
* given name, or %NULL if there is no extension with that name
*/
GIOExtension *
* Gets a reference to the class for the type that is
* associated with @extension.
*
- * Returns: the #GTypeClass for the type of @extension
+ * Returns: (transfer full): the #GTypeClass for the type of @extension
*/
GTypeClass *
g_io_extension_ref_class (GIOExtension *extension)
* run gio-querymodules in order to build the cache files required for
* lazy loading.
*
- * Returns: A %NULL-terminated array of strings, listing the supported
+ * Returns: (transfer full): A %NULL-terminated array of strings, listing the supported
* extension points of the module. The array must be suitable for
* freeing with g_strfreev().
*
* @root_path: the path under which all settings keys appear
* @root_group: (allow-none): the group name corresponding to
* @root_path, or %NULL
- * @returns: a keyfile-backed #GSettingsBackend
+ * @returns: (transfer full): a keyfile-backed #GSettingsBackend
*
* Creates a keyfile-backed #GSettingsBackend.
*
* Loads a loadable icon. For the asynchronous version of this function,
* see g_loadable_icon_load_async().
*
- * Returns: a #GInputStream to read the icon from.
+ * Returns: (transfer full): a #GInputStream to read the icon from.
**/
GInputStream *
g_loadable_icon_load (GLoadableIcon *icon,
*
* Finishes an asynchronous icon load started in g_loadable_icon_load_async().
*
- * Returns: a #GInputStream to read the icon from.
+ * Returns: (transfer full): a #GInputStream to read the icon from.
**/
GInputStream *
g_loadable_icon_load_finish (GLoadableIcon *icon,
}
/**
- * g_memory_output_stream_get_data:
+ * g_memory_output_stream_get_data: (skip)
* @ostream: a #GMemoryOutputStream
*
* Gets any loaded data from the @ostream.
* @mount is a path that reflects the main entry point for the user (e.g.
* the home directory, or the root of the volume).
*
- * Returns: a #GFile.
+ * Returns: (transfer full): a #GFile.
* The returned object should be unreffed with
* g_object_unref() when no longer needed.
**/
* %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
* guessing.
*
- * Returns: a %NULL-terminated array of content types or %NULL on error.
+ * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error.
* Caller should free this array with g_strfreev() when done with it.
*
* Since: 2.18
* This is an synchronous operation and as such may block doing IO;
* see g_mount_guess_content_type() for the asynchronous version.
*
- * Returns: a %NULL-terminated array of content types or %NULL on error.
+ * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error.
* Caller should free this array with g_strfreev() when done with it.
*
* Since: 2.18
* Creates a new #GSocketConnectable for connecting to the given
* @hostname and @port.
*
- * Return value: the new #GNetworkAddress
+ * Return value: (transfer full): the new #GNetworkAddress
*
* Since: 2.22
*/
* @hostname and @port. May fail and return %NULL in case
* parsing @host_and_port fails.
*
- * @host_and_port may be in any of a number of recognised formats: an IPv6
+ * @host_and_port may be in any of a number of recognised formats; an IPv6
* address, an IPv4 address, or a domain name (in which case a DNS
* lookup is performed). Quoting with [] is supported for all address
* types. A port override may be specified in the usual way with a
* (allowing them to give the hostname, and a port overide if necessary)
* and @default_port is expected to be provided by the application.
*
- * Return value: the new #GNetworkAddress, or %NULL on error
+ * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
*
* Since: 2.22
*/
* g_network_address_parse_host() allows #GSocketClient to determine
* when to use application-specific proxy protocols.
*
- * Return value: the new #GNetworkAddress, or %NULL on error
+ * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
*
* Since: 2.26
*/
* @protocol, and @domain. This will initially be unresolved; use the
* #GSocketConnectable interface to resolve it.
*
- * Return value: a new #GNetworkService
+ * Return value: (transfer full): a new #GNetworkService
*
* Since: 2.22
*/
/**
* g_output_stream_write:
* @stream: a #GOutputStream.
- * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
+ * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write.
* @count: the number of bytes to write
* @cancellable: optional cancellable object
* @error: location to store the error occuring, or %NULL to ignore
/**
* g_output_stream_write_all:
* @stream: a #GOutputStream.
- * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
+ * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write.
* @count: the number of bytes to write
* @bytes_written: location to store the number of bytes that was
* written to the stream
/**
* g_output_stream_write_async:
* @stream: A #GOutputStream.
- * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write.
+ * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write.
* @count: the number of bytes to write
* @io_priority: the io priority of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* does the necessary handshake to connect to @proxy_address, and if
* required, wraps the #GIOStream to handle proxy payload.
*
- * Return value: a #GIOStream that will replace @connection. This might
+ * Return value: (transfer full): a #GIOStream that will replace @connection. This might
* be the same as @connection, in which case a reference
* will be added.
*
*
* See g_proxy_connect().
*
- * Return value: a #GIOStream.
+ * Return value: (transfer full): a #GIOStream.
*
* Since: 2.26
*/
*
* Gets the default #GProxyResolver for the system.
*
- * Return value: the default #GProxyResolver.
+ * Return value: (transfer none): the default #GProxyResolver.
*
* Since: 2.26
*/
* Direct connection should not be attempted unless it is part of the
* returned array of proxies.
*
- * Return value: A NULL-terminated array of proxy URIs. Must be freed with
+ * Return value: (transfer full) (element-type utf8): A NULL-terminated array of proxy URIs. Must be freed with
* g_strfreev().
*
* Since: 2.26
* g_proxy_resolver_lookup_async() is complete. See
* g_proxy_resolver_lookup() for more details.
*
- * Return value: A NULL-terminated array of proxy URIs. Must be freed with
+ * Return value: (transfer full) (element-type utf8): A NULL-terminated array of proxy URIs. Must be freed with
* g_strfreev().
*
* Since: 2.26
* many threads/processes, etc it should allocate for concurrent DNS
* resolutions.
*
- * Return value: the default #GResolver.
+ * Return value: (transfer full): the default #GResolver.
*
* Since: 2.22
*/
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
* operation was partially finished when the operation was cancelled the
* partial result will be returned, without an error.
- *
+ *
+ * Virtual: truncate_fn
* Returns: %TRUE if successful. If an error
* has occurred, this function will return %FALSE and set @error
* appropriately if present.
* @mapping: the function to map the value in the settings database to
* the value used by the application
* @user_data: user data for @mapping
- * @returns: the result, which may be %NULL
+ * @returns: (transfer full): the result, which may be %NULL
*
* Gets the value that is stored at @key in @settings, subject to
* application-level validation/mapping.
* g_settings_get_child:
* @settings: a #GSettings object
* @name: the name of the 'child' schema
- * @returns: a 'child' settings object
+ * @returns: (transfer full): a 'child' settings object
*
* Creates a 'child' settings object which has a base path of
* <replaceable>base-path</replaceable>/@name", where
/**
* g_settings_list_keys:
* @settings: a #GSettings object
- * @returns: a list of the keys on @settings
+ * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
*
* Introspects the list of keys on @settings.
*
/**
* g_settings_list_children:
* @settings: a #GSettings object
- * @returns: a list of the children on @settings
+ * @returns: (transfer full) (element-type utf8): a list of the children on @settings
*
* Gets the list of children on @settings.
*
* implementations should call this if a key has possibly changed its
* value.
*
- * @key must be a valid key (ie: starting with a slash, not containing
+ * @key must be a valid key (ie starting with a slash, not containing
* '//', and not ending with a slash).
*
* The implementation must call this function during any call to
* implementations should call this if keys have possibly changed their
* values.
*
- * @path must be a valid path (ie: starting and ending with a slash and
+ * @path must be a valid path (ie starting and ending with a slash and
* not containing '//'). Each string in @items must form a valid key
* name when @path is prefixed to it (ie: each item must not start or
* end with '/' and must not contain '//').
* Backend implementations should call this if an entire path of keys
* have possibly changed their values.
*
- * @path must be a valid path (ie: starting and ending with a slash and
+ * @path must be a valid path (ie starting and ending with a slash and
* not containing '//').
*
* The meaning of this signal is that any of the key which has a name
* g_settings_list_schemas:
* @returns: a list of the schemas installed on the system
*
- * Returns a list of GSettings schemas that are available. The list
+ * Returns: (element-type utf8) (transfer none): a list of GSettings schemas that are available. The list
* must not be modified or freed.
**/
const gchar * const *
}
/**
- * g_simple_async_result_get_source_tag:
+ * g_simple_async_result_get_source_tag: (skip)
* @simple: a #GSimpleAsyncResult.
*
* Gets the source tag for the #GSimpleAsyncResult.
}
/**
- * g_simple_async_result_get_op_res_gpointer:
+ * g_simple_async_result_get_op_res_gpointer: (skip):
* @simple: a #GSimpleAsyncResult.
*
* Gets a pointer result as returned by the asynchronous function.
* useful if the socket has been bound to a local address,
* either explicitly or implicitly when connecting.
*
- * Returns: a #GSocketAddress or %NULL on error.
+ * Returns: (transfer full): a #GSocketAddress or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* Try to get the remove address of a connected socket. This is only
* useful for connection oriented sockets that have been connected.
*
- * Returns: a #GSocketAddress or %NULL on error.
+ * Returns: (transfer full): a #GSocketAddress or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
* To be notified of an incoming connection, wait for the %G_IO_IN condition.
*
- * Returns: a new #GSocket, or %NULL on error.
+ * Returns: (transfer full): a new #GSocket, or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* marked as having had a timeout, and so the next #GSocket I/O method
* you call will then fail with a %G_IO_ERROR_TIMED_OUT.
*
- * Returns: a newly allocated %GSource, free with g_source_unref().
+ * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref().
*
* Since: 2.22
*/
* g_unix_connection_send_credentials() /
* g_unix_connection_receive_credentials() functions.
*
- * Returns: %NULL if @error is set, otherwise a #GCredentials object
+ * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object
* that must be freed with g_object_unref().
*
* Since: 2.26
* internal errors (other than @cancellable being triggered) will be
* ignored.
*
- * Return value: a #GSocketAddress (owned by the caller), or %NULL on
+ * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on
* error (in which case *@error will be set) or if there are no
* more addresses.
*/
* g_socket_address_enumerator_next() for more information about
* error handling.
*
- * Return value: a #GSocketAddress (owned by the caller), or %NULL on
+ * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on
* error (in which case *@error will be set) or if there are no
* more addresses.
*/
* If a local address is specified with g_socket_client_set_local_address() the
* socket will be bound to this address before connecting.
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
*
* Attempts to create a TCP connection to the named host.
*
- * @host_and_port may be in any of a number of recognised formats: an IPv6
+ * @host_and_port may be in any of a number of recognised formats; an IPv6
* address, an IPv4 address, or a domain name (in which case a DNS
* lookup is performed). Quoting with [] is supported for all address
* types. A port override may be specified in the usual way with a
* connectable) %NULL is returned and @error (if non-%NULL) is set
* accordingly.
*
- Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
* @service: the name of the service to connect to
* @cancellable: a #GCancellable, or %NULL
* @error: a pointer to a #GError, or %NULL
- * @returns: a #GSocketConnection if successful, or %NULL on error
+ * @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error
*
* Attempts to create a TCP connection to a service.
*
* connectable) %NULL is returned and @error (if non-%NULL) is set
* accordingly.
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.26
*/
*
* Finishes an async connect operation. See g_socket_client_connect_async()
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
*
* Finishes an async connect operation. See g_socket_client_connect_to_host_async()
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
*
* Finishes an async connect operation. See g_socket_client_connect_to_service_async()
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
*
* Finishes an async connect operation. See g_socket_client_connect_to_uri_async()
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.26
*/
*
* Creates a #GSocketAddressEnumerator for @connectable.
*
- * Return value: a new #GSocketAddressEnumerator.
+ * Return value: (transfer full): a new #GSocketAddressEnumerator.
*
* Since: 2.22
*/
* g_socket_connectable_proxy_enumerate(), this will fall back to
* calling g_socket_connectable_enumerate().
*
- * Return value: a new #GSocketAddressEnumerator.
+ * Return value: (transfer full): a new #GSocketAddressEnumerator.
*
* Since: 2.26
*/
*
* Try to get the local address of a socket connection.
*
- * Returns: a #GSocketAddress or %NULL on error.
+ * Returns: (transfer full): a #GSocketAddress or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
*
* Try to get the remote address of a socket connection.
*
- * Returns: a #GSocketAddress or %NULL on error.
+ * Returns: (transfer full): a #GSocketAddress or %NULL on error.
* Free the returned object with g_object_unref().
*
* Since: 2.22
* Creates a #GSocketConnection subclass of the right type for
* @socket.
*
- * Returns: a #GSocketConnection
+ * Returns: (transfer full): a #GSocketConnection
*
* Since: 2.22
*/
* If there is no implementation for this kind of control message, %NULL
* will be returned.
*
- * Returns: the deserialized message or %NULL
+ * Returns: (transfer full): the deserialized message or %NULL
*
* Since: 2.22
*/
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a #GSocket on success, %NULL on error.
+ * Returns: (transfer full): a #GSocket on success, %NULL on error.
*
* Since: 2.22
*/
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
*
* Finishes an async accept operation. See g_socket_listener_accept_socket_async()
*
- * Returns: a #GSocket on success, %NULL on error.
+ * Returns: (transfer full): a #GSocket on success, %NULL on error.
*
* Since: 2.22
*/
*
* Finishes an async accept operation. See g_socket_listener_accept_async()
*
- * Returns: a #GSocketConnection on success, %NULL on error.
+ * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
*
* Since: 2.22
*/
*
* Sorts @targets in place according to the algorithm in RFC 2782.
*
- * Return value: the head of the sorted list.
+ * Return value: (transfer full): the head of the sorted list.
*
* Since: 2.22
*/
*
* Creates a new themed icon for @iconname.
*
- * Returns: a new #GThemedIcon.
+ * Returns: (transfer full): a new #GThemedIcon.
**/
GIcon *
g_themed_icon_new (const char *iconname)
*
* Creates a new themed icon for @iconnames.
*
- * Returns: a new #GThemedIcon
+ * Returns: (transfer full): a new #GThemedIcon
**/
GIcon *
g_themed_icon_new_from_names (char **iconnames,
* icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
* ]|
*
- * Returns: a new #GThemedIcon.
+ * Returns: (transfer full): a new #GThemedIcon.
*/
GIcon *
g_themed_icon_new_with_default_fallbacks (const char *iconname)
*
* Gets the names of icons from within @icon.
*
- * Returns: a list of icon names.
+ * Returns: (transfer full): a list of icon names.
*/
const char * const *
g_themed_icon_get_names (GThemedIcon *icon)
*
* Gets the volume monitor used by gio.
*
- * Returns: a reference to the #GVolumeMonitor used by gio. Call
+ * Returns: (transfer full): a reference to the #GVolumeMonitor used by gio. Call
* g_object_unref() when done with it.
**/
GVolumeMonitor *
* Other ways to exchange credentials with a foreign peer includes the
* #GUnixCredentialsMessage type and g_socket_get_credentials() function.
*
- * Returns: Received credentials on success (free with
+ * Returns: (transfer full): Received credentials on success (free with
* g_object_unref()), %NULL if @error is set.
*
* Since: 2.26
*
* Gets the credentials stored in @message.
*
- * Returns: A #GCredentials instance. Do not free, it is owned by @message.
+ * Returns: (transfer none): A #GCredentials instance. Do not free, it is owned by @message.
*
* Since: 2.26
*/
* return a reference to the caller, but the returned list is valid for
* the lifetime of @message.
*
- * Returns: the #GUnixFDList from @message
+ * Returns: (transfer none): the #GUnixFDList from @message
*
* Since: 2.24
**/
* is set, it will be filled with a unix timestamp for checking
* if the mounts have changed since with g_unix_mounts_changed_since().
*
- * Returns: a #GUnixMount.
+ * Returns: (transfer full): a #GUnixMount.
**/
GUnixMountEntry *
g_unix_mount_at (const char *mount_path,
*
* Guesses the icon of a Unix mount.
*
- * Returns: a #GIcon
+ * Returns: (transfer full): a #GIcon
*/
GIcon *
g_unix_mount_guess_icon (GUnixMountEntry *mount_entry)
*
* Guesses the icon of a Unix mount point.
*
- * Returns: a #GIcon
+ * Returns: (transfer full): a #GIcon
*/
GIcon *
g_unix_mount_point_guess_icon (GUnixMountPoint *mount_point)
*
* Gets a #GFile for @path.
*
- * Returns: a #GFile.
+ * Returns: (transfer full): a #GFile.
* Free the returned object with g_object_unref().
**/
GFile *
* might not support any I/O operation if the URI
* is malformed or if the URI scheme is not supported.
*
- * Returns: a #GFile.
+ * Returns: (transfer full): a #GFile.
* Free the returned object with g_object_unref().
**/
GFile *
*
* Gets a list of URI schemes supported by @vfs.
*
- * Returns: a %NULL-terminated array of strings.
+ * Returns: (transfer none): a %NULL-terminated array of strings.
* The returned array belongs to GIO and must
* not be freed or modified.
**/
* not support any I/O operations if the @parse_name cannot
* be parsed by the #GVfs module.
*
- * Returns: a #GFile for the given @parse_name.
+ * Returns: (transfer full): a #GFile for the given @parse_name.
* Free the returned object with g_object_unref().
**/
GFile *
*
* Gets the default #GVfs for the system.
*
- * Returns: a #GVfs.
+ * Returns: (transfer none): a #GVfs.
**/
GVfs *
g_vfs_get_default (void)
*
* Gets the local #GVfs for the system.
*
- * Returns: a #GVfs.
+ * Returns: (transfer none): a #GVfs.
**/
GVfs *
g_vfs_get_local (void)
* 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.
+ *
+ * Virtual: mount_fn
**/
void
g_volume_mount (GVolume *volume,
*
* Finds a #GMount object by its UUID (see g_mount_get_uuid())
*
- * Returns: a #GMount or %NULL if no such mount is available.
+ * Returns: (transfer full): a #GMount or %NULL if no such mount is available.
* Free the returned object with g_object_unref().
**/
GMount *