1 /************************************************************/
2 /* THIS FILE IS GENERATED DO NOT EDIT */
3 /************************************************************/
6 * g_mount_guess_content_type:
8 * @force_rescan: Whether to force a rescan of the content. Otherwise a cached result will be used if available
9 * @cancellable: optional #GCancellable object, %NULL to ignore
10 * @callback: a #GAsyncReadyCallback
11 * @user_data: user data passed to @callback
13 * Tries to guess the type of content stored on @mount. Returns one or
14 * more textual identifiers of well-known content types (typically
15 * prefixed with "x-content/"), e.g. x-content/image-dcf for camera
16 * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
17 * specification for more on x-content types.
18 * This is an asynchronous operation (see
19 * g_mount_guess_content_type_sync() for the synchronous version), and
20 * is finished by calling g_mount_guess_content_type_finish() with the
27 * GFileQueryInfoFlags:
28 * @G_FILE_QUERY_INFO_NONE: No flags set.
29 * @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks.
31 * Flags used when querying a #GFileInfo.
36 * g_output_stream_flush_async:
37 * @stream: a #GOutputStream.
38 * @io_priority: the io priority of the request.
39 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
40 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
41 * @user_data: (closure): the data to pass to callback function
43 * Flushes a stream asynchronously.
44 * For behaviour details see g_output_stream_flush().
45 * When the operation is finished @callback will be
46 * called. You can then call g_output_stream_flush_finish() to get the
47 * result of the operation.
52 * GZlibDecompressor:file-info:
54 * A #GFileInfo containing the information found in the GZIP header
55 * of the data stream processed, or %NULL if the header was not yet
56 * fully processed, is not present at all, or the compressor's
57 * #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP.
64 * G_VARIANT_TYPE_STRING_ARRAY:
66 * The type of an array of strings.
71 * g_file_attribute_info_list_ref:
72 * @list: a #GFileAttributeInfoList to reference.
74 * References a file attribute info list.
76 * Returns: #GFileAttributeInfoList or %NULL on error.
81 * g_drive_is_media_check_automatic:
84 * Checks if @drive is capabable of automatically detecting media changes.
85 * media changes, %FALSE otherwise.
87 * Returns: %TRUE if the @drive is capabable of automatically detecting
92 * GUnixCredentialsMessage:
94 * The #GUnixCredentialsMessage structure contains only private data
95 * and should only be accessed using the provided API.
102 * g_dbus_message_set_header:
103 * @message: A #GDBusMessage.
104 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
105 * @value: A #GVariant to set the header field or %NULL to clear the header field.
107 * Sets a header field on @message.
108 * If @value is floating, @message assumes ownership of @value.
115 * G_FILE_ATTRIBUTE_FILESYSTEM_TYPE:
117 * A key in the "filesystem" namespace for getting the file system's type.
118 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
123 * g_app_info_add_supports_type:
124 * @appinfo: a #GAppInfo.
125 * @content_type: a string.
128 * Adds a content type to the application information to indicate the
129 * application is capable of opening files with the given content type.
131 * Returns: %TRUE on success, %FALSE on error.
136 * g_file_info_get_size:
137 * @info: a #GFileInfo.
139 * Gets the file's size.
141 * Returns: a #goffset containing the file's size.
146 * g_dbus_interface_info_lookup_signal:
147 * @info: A #GDBusInterfaceInfo.
148 * @name: A D-Bus signal name (typically in CamelCase)
150 * Looks up information about a signal.
151 * This cost of this function is O(n) in number of signals.
153 * Returns: A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info.
159 * g_dbus_connection_flush_sync:
160 * @connection: A #GDBusConnection.
161 * @cancellable: A #GCancellable or %NULL.
162 * @error: Return location for error or %NULL.
164 * Synchronously flushes @connection. The calling thread is blocked
165 * until this is done. See g_dbus_connection_flush() for the
166 * asynchronous version of this method and more details about what it
169 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
175 * g_dbus_message_set_signature:
176 * @message: A #GDBusMessage.
177 * @value: The value to set.
179 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
186 * GTlsBackendInterface:
187 * @g_iface: The parent interface.
188 * @get_certificate_type: returns the #GTlsCertificate implementation type
189 * @get_client_connection_type: returns the #GTlsClientConnection implementation type
190 * @get_server_connection_type: returns the #GTlsServerConnection implementation type
192 * Provides an interface for describing TLS-related types.
199 * g_file_make_symbolic_link:
200 * @file: a #GFile with the name of the symlink to create
201 * @symlink_value: a string with the path for the target of the new symlink
202 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
205 * Creates a symbolic link named @file which contains the string
206 * If @cancellable is not %NULL, then the operation can be cancelled by
207 * triggering the cancellable object from another thread. If the operation
208 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
210 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
215 * g_io_stream_has_pending:
216 * @stream: a #GIOStream
218 * Checks if a stream has pending actions.
220 * Returns: %TRUE if @stream has pending actions.
227 * @g_class: Location of a valid #GTypeClass structure.
229 * Get the type identifier from a given @class structure.
230 * This macro should only be used in type implementations.
232 * Returns: the #GType
238 * @g_iface: The parent interface.
239 * @get_user_data: Gets the user data passed to the callback.
240 * @get_source_object: Gets the source object that issued the asynchronous operation.
242 * Interface definition for #GAsyncResult.
249 * The fundamental type corresponding to #guchar.
254 * g_dbus_message_get_message_type:
255 * @message: A #GDBusMessage.
257 * Gets the type of @message.
259 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
265 * SECTION:gdbusnamewatchin:
266 * @title: Watching Bus Names
267 * @short_description: Simple API for watching bus names
268 * @include: gio/gio.h
270 * Convenience API for watching bus names.
271 * <example id="gdbus-watching-names"><title>Simple application watching a name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-watch-name.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
276 * GDBusProxy:g-flags:
278 * Flags from the #GDBusProxyFlags enumeration.
285 * g_socket_listener_new:
287 * Creates a new #GSocketListener with no sockets to listen for.
288 * New listeners can be added with e.g. g_socket_listener_add_address()
289 * or g_socket_listener_add_inet_port().
291 * Returns: a new #GSocketListener.
297 * g_tls_client_connection_set_use_ssl3:
298 * @conn: the #GTlsClientConnection
299 * @use_ssl3: whether to use SSL 3.0
301 * If @use_ssl3 is %TRUE, this forces @conn to use SSL 3.0 rather than
302 * trying to properly negotiate the right version of TLS or SSL to use.
303 * This can be used when talking to servers that do not implement the
304 * fallbacks correctly and which will therefore fail to handshake with
305 * a "modern" TLS handshake attempt.
312 * g_bus_watch_name_with_closures:
313 * @bus_type: The type of bus to watch a name on.
314 * @name: The name (well-known or unique) to watch.
315 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
316 * @name_appeared_closure: (allow-none): #GClosure to invoke when @name is known to exist or %NULL.
317 * @name_vanished_closure: (allow-none): #GClosure to invoke when @name is known to not exist or %NULL.
319 * Version of g_bus_watch_name() using closures instead of callbacks for
320 * easier binding in other languages.
321 * g_bus_unwatch_name() to stop watching the name.
323 * Returns: An identifier (never 0) that an be used with
324 * Rename to: g_bus_watch_name
330 * g_tls_connection_set_certificate:
331 * @conn: a #GTlsConnection
332 * @certificate: the certificate to use for @conn
334 * This sets the certificate that @conn will present to its peer
335 * during the TLS handshake. For a #GTlsServerConnection, it is
336 * mandatory to set this, and that will normally be done at construct
338 * For a #GTlsClientConnection, this is optional. If a handshake fails
339 * with %G_TLS_ERROR_CERTIFICATE_REQUIRED, that means that the server
340 * requires a certificate, and if you try connecting again, you should
341 * call this method first. You can call
342 * g_tls_client_connection_get_accepted_cas() on the failed connection
343 * to get a list of Certificate Authorities that the server will
344 * accept certificates from.
345 * (It is also possible that a server will allow the connection with
346 * or without a certificate; in that case, if you don't provide a
347 * certificate, you can tell that the server requested one by the fact
348 * that g_tls_client_connection_get_accepted_cas() will return
356 * GObjectSetPropertyFunc:
357 * @object: a #GObject
358 * @property_id: the numeric id under which the property was registered with g_object_class_install_property().
359 * @value: the new value for the property
360 * @pspec: the #GParamSpec describing the property
362 * The type of the @set_property function of #GObjectClass.
367 * GSocketControlMessageClass:
368 * @get_size: gets the size of the message.
369 * @get_level: gets the protocol of the message.
370 * @get_type: gets the protocol specific type of the message.
371 * @serialize: Writes out the message data.
372 * @deserialize: Tries to deserialize a message.
379 * g_converter_output_stream_new:
380 * @base_stream: a #GOutputStream
381 * @converter: a #GConverter
383 * Creates a new converter output stream for the @base_stream.
385 * Returns: a new #GOutputStream.
390 * GPollableOutputStreamInterface:
391 * @g_iface: The parent interface.
392 * @can_poll: Checks if the #GPollableOutputStream instance is actually pollable
393 * @is_writable: Checks if the stream is writable
394 * @create_source: Creates a #GSource to poll the stream
395 * @write_nonblocking: Does a non-blocking write or returns %G_IO_ERROR_WOULD_BLOCK
397 * The interface for pollable output streams.
398 * The default implementation of @can_poll always returns %TRUE.
399 * The default implementation of @write_nonblocking calls
400 * g_pollable_output_stream_is_writable(), and then calls
401 * g_output_stream_write() if it returns %TRUE. This means you only
402 * need to override it if it is possible that your @is_writable
403 * implementation may return %TRUE when the stream is not actually
412 * @g_class: The #GTypeClass structure to initialize.
414 * A callback function used by the type system to do base initialization
415 * of the class structures of derived types. It is called as part of the
416 * initialization process of all derived classes and should reallocate
417 * or reset all dynamic class members copied over from the parent class.
418 * For example, class members (such as strings) that are not sufficiently
419 * handled by a plain memory copy of the parent class into the derived class
420 * have to be altered. See GClassInitFunc() for a discussion of the class
421 * intialization process.
428 * Defines a Unix mount point (e.g. <filename>/dev</filename>).
429 * This corresponds roughly to a fstab entry.
434 * g_async_result_get_user_data:
435 * @res: a #GAsyncResult.
437 * Gets the user data from a #GAsyncResult.
439 * Returns: (transfer full): the user data for @res.
444 * g_file_poll_mountable:
445 * @file: input #GFile.
446 * @cancellable: optional #GCancellable object, %NULL to ignore.
447 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
448 * @user_data: the data to pass to callback function
450 * Polls a file of type G_FILE_TYPE_MOUNTABLE.
451 * If @cancellable is not %NULL, then the operation can be cancelled by
452 * triggering the cancellable object from another thread. If the operation
453 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
454 * When the operation is finished, @callback will be called. You can then call
455 * g_file_mount_mountable_finish() to get the result of the operation.
462 * g_socket_check_connect_result:
463 * @socket: a #GSocket
464 * @error: #GError for error reporting, or %NULL to ignore.
466 * Checks and resets the pending connect error for the socket.
467 * This is used to check for errors when g_socket_connect() is
468 * used in non-blocking mode.
470 * Returns: %TRUE if no error, %FALSE otherwise, setting @error to the error
477 * @filename: filename of the shared library module.
479 * Creates a new GIOModule that will load the specific
480 * shared library when in use.
483 * Returns: a #GIOModule from given @filename,
488 * GTlsConnection::accept-certificate:
489 * @conn: a #GTlsConnection
490 * @peer_cert: the peer's #GTlsCertificate
491 * @errors: the problems with @peer_cert.
493 * Emitted during the TLS handshake after the peer certificate has
494 * been received. You can examine @peer_cert's certification path by
495 * calling g_tls_certificate_get_issuer() on it.
496 * For a client-side connection, @peer_cert is the server's
497 * certificate, and the signal will only be emitted if the
498 * certificate was not acceptable according to @conn's
499 * #GTlsClientConnection:validation_flags. If you would like the
500 * certificate to be accepted despite @errors, return %TRUE from the
501 * signal handler. Otherwise, if no handler accepts the certificate,
502 * the handshake will fail with %G_TLS_ERROR_BAD_CERTIFICATE.
503 * For a server-side connection, @peer_cert is the certificate
504 * presented by the client, if this was requested via the server's
505 * #GTlsServerConnection:authentication_mode. On the server side,
506 * the signal is always emitted when the client presents a
507 * certificate, and the certificate will only be accepted if a
508 * handler returns %TRUE.
509 * Note that if this signal is emitted as part of asynchronous I/O
510 * in the main thread, then you should not attempt to interact with
511 * the user before returning from the signal handler. If you want to
512 * let the user decide whether or not to accept the certificate, you
513 * would have to return %FALSE from the signal handler on the first
514 * attempt, and then after the connection attempt returns a
515 * %G_TLS_ERROR_HANDSHAKE, you can interact with the user, and if
516 * the user decides to accept the certificate, remember that fact,
517 * create a new connection, and return %TRUE from the signal handler
519 * If you are doing I/O in another thread, you do not
520 * need to worry about this, and can simply block in the signal
521 * handler until the UI thread returns an answer.
522 * immediately end the signal emission). %FALSE to allow the signal
523 * emission to continue, which will cause the handshake to fail if
524 * no one else overrides it.
526 * Returns: %TRUE to accept @peer_cert (which will also
533 * @option_name: 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.
534 * @value: The value to be parsed.
535 * @data: User data added to the #GOptionGroup containing the option when it was created with g_option_group_new()
536 * @error: A return location for errors. The error code %G_OPTION_ERROR_FAILED is intended to be used for errors in #GOptionArgFunc callbacks.
538 * The type of function to be passed as callback for %G_OPTION_ARG_CALLBACK
540 * occurred, in which case @error should be set with g_set_error()
542 * Returns: %TRUE if the option was successfully parsed, %FALSE if an error
548 * @application_id: the application id
549 * @flags: the application flags
550 * @returns: a new #GApplication instance
552 * Creates a new #GApplication instance.
553 * This function calls g_type_init() for you.
554 * The application id must be valid. See g_application_id_is_valid().
559 * g_dbus_connection_get_capabilities:
560 * @connection: A #GDBusConnection.
562 * Gets the capabilities negotiated with the remote peer
564 * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
572 * A single target host/port that a network service is running on.
577 * g_dbus_connection_close:
578 * @connection: A #GDBusConnection.
579 * @cancellable: A #GCancellable or %NULL.
580 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result.
581 * @user_data: The data to pass to @callback.
583 * Closes @connection. Note that this never causes the process to
584 * exit (this might only happen if the other end of a shared message
585 * bus connection disconnects, see #GDBusConnection:exit-on-close).
586 * Once the connection is closed, operations such as sending a message
587 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
588 * will not automatically flush the connection so queued messages may
589 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
590 * If @connection is already closed, this method fails with
591 * %G_IO_ERROR_CLOSED.
592 * When @connection has been closed, the #GDBusConnection::closed
593 * signal is emitted in the <link
594 * linkend="g-main-context-push-thread-default">thread-default main
595 * loop</link> of the thread that @connection was constructed in.
596 * This is an asynchronous method. When the operation is finished,
597 * linkend="g-main-context-push-thread-default">thread-default main
598 * loop</link> of the thread you are calling this method from. You can
599 * then call g_dbus_connection_close_finish() to get the result of the
600 * operation. See g_dbus_connection_close_sync() for the synchronous
608 * g_resolver_lookup_by_address:
609 * @resolver: a #GResolver
610 * @address: the address to reverse-resolve
611 * @cancellable: (allow-none): a #GCancellable, or %NULL
612 * @error: return location for a #GError, or %NULL
614 * Synchronously reverse-resolves @address to determine its
615 * associated hostname.
616 * If the DNS resolution fails, @error (if non-%NULL) will be set to
617 * a value from #GResolverError.
618 * If @cancellable is non-%NULL, it can be used to cancel the
619 * operation, in which case @error (if non-%NULL) will be set to
620 * %G_IO_ERROR_CANCELLED.
621 * form), or %NULL on error.
623 * Returns: a hostname (either ASCII-only, or in ASCII-encoded
629 * GDataStream:newline-type:
631 * The :newline-type property determines what is considered
632 * as a line ending when reading complete lines from the stream.
637 * GFileProgressCallback:
638 * @current_num_bytes: the current number of bytes in the operation.
639 * @total_num_bytes: the total number of bytes in the operation.
640 * @user_data: user data passed to the callback.
642 * When doing file operations that may take a while, such as moving
643 * a file or copying a file, a progress callback is used to pass how
644 * far along that operation is to the application.
651 * All the fields in the <structname>GInitiallyUnowned</structname> structure
652 * are private to the #GInitiallyUnowned implementation and should never be
660 * The <structname>GApplication</structname> structure contains private
661 * data and should only be accessed using the provided API
668 * SECTION:gdbusnameownin:
669 * @title: Owning Bus Names
670 * @short_description: Simple API for owning bus names
671 * @include: gio/gio.h
673 * Convenience API for owning bus names.
674 * <example id="gdbus-owning-names"><title>Simple application owning a name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-own-name.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
679 * GInetAddress:is-loopback:
681 * Whether this is the loopback address for its family.
682 * See g_inet_address_get_is_loopback().
689 * G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER:
691 * A key in the "standard" namespace for setting the sort order of a file.
692 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32.
693 * An example use would be in file managers, which would use this key
694 * to set the order files are displayed. Files with smaller sort order
695 * should be sorted first, and files without sort order as if sort order
703 * An opaque structure used as the base of all interface types.
710 * The type ID of the "GValue" type which is a boxed type,
711 * used to pass around pointers to GValues.
718 * The path within the backend where the settings are stored.
723 * GDBusMethodInvocationClass:
725 * Class structure for #GDBusMethodInvocation.
732 * G_PARAM_SPEC_TYPE_NAME:
733 * @pspec: a valid #GParamSpec
735 * Retrieves the #GType name of this @pspec.
740 * g_dbus_method_invocation_get_user_data: (skip)
741 * @invocation: A #GDBusMethodInvocation.
743 * Gets the @user_data #gpointer passed to g_dbus_connection_register_object().
745 * Returns: A #gpointer.
751 * g_unix_mount_point_guess_icon:
752 * @mount_point: a #GUnixMountPoint
754 * Guesses the icon of a Unix mount point.
756 * Returns: (transfer full): a #GIcon
762 * @settings: a #GSettings object
763 * @key: the key to get the value for
764 * @format: a #GVariant format string
765 * @...: arguments as per @format
767 * Gets the value that is stored at @key in @settings.
768 * A convenience function that combines g_settings_get_value() with
770 * It is a programmer error to give a @key that isn't contained in the
771 * schema for @settings or for the #GVariantType of @format to mismatch
772 * the type given in the schema.
779 * g_socket_control_message_get_size:
780 * @message: a #GSocketControlMessage
782 * Returns the space required for the control message, not including
783 * headers or alignment.
785 * Returns: The number of bytes required.
791 * g_settings_new_with_path:
792 * @schema: the name of the schema
793 * @path: the path to use
794 * @returns: a new #GSettings object
796 * Creates a new #GSettings object with a given schema and path.
797 * You only need to do this if you want to directly create a settings
798 * object with a schema that doesn't have a specified path of its own.
800 * It is a programmer error to call this function for a schema that
801 * has an explicitly specified path.
808 * g_file_info_set_edit_name:
809 * @info: a #GFileInfo.
810 * @edit_name: a string containing an edit name.
812 * Sets the edit name for the current file.
813 * See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME.
821 * Checks if a drive can be started.
823 * Returns: %TRUE if the @drive can be started, %FALSE otherwise.
829 * g_socket_service_is_active:
830 * @service: a #GSocketService
832 * Check whether the service is active or not. An active
833 * service will accept new clients that connect, while
834 * a non-active service will let connecting clients queue
835 * up until the service is started.
837 * Returns: %TRUE if the service is active, %FALSE otherwise
846 * Returns %TRUE if a #GNode is a leaf node.
847 * (i.e. it has no children)
849 * Returns: %TRUE if the #GNode is a leaf node
854 * GTlsConnection:rehandshake-mode:
856 * The rehandshaking mode. See
857 * g_tls_connection_set_rehandshake_mode().
864 * g_proxy_address_get_usernam:
865 * @proxy: a #GProxyAddress
867 * Gets @proxy's username.
869 * Returns: the @proxy's username
876 * @initable: a #GInitable.
877 * @cancellable: optional #GCancellable object, %NULL to ignore.
878 * @error: a #GError location to store the error occuring, or %NULL to ignore.
880 * Initializes the object implementing the interface. This must be
881 * done before any real use of the object after initial construction.
882 * Implementations may also support cancellation. If @cancellable is not %NULL,
883 * then initialization can be cancelled by triggering the cancellable object
884 * from another thread. If the operation was cancelled, the error
885 * %G_IO_ERROR_CANCELLED will be returned. If @cancellable is not %NULL and
886 * the object doesn't support cancellable initialization the error
887 * %G_IO_ERROR_NOT_SUPPORTED will be returned.
888 * If this function is not called, or returns with an error then all
889 * operations on the object should fail, generally returning the
890 * error %G_IO_ERROR_NOT_INITIALIZED.
891 * Implementations of this method must be idempotent, i.e. multiple calls
892 * to this function with the same argument should return the same results.
893 * Only the first call initializes the object, further calls return the result
894 * of the first call. This is so that its safe to implement the singleton
895 * pattern in the GObject constructor function.
896 * return %FALSE and set @error appropriately if present.
898 * Returns: %TRUE if successful. If an error has occurred, this function will
904 * g_drive_enumerate_identifiers:
907 * Gets the kinds of identifiers that @drive has.
908 * Use g_drive_get_identifer() to obtain the identifiers
910 * kinds of identifiers. Use g_strfreev() to free.
912 * Returns: (transfer full): a %NULL-terminated array of strings containing
917 * g_volume_monitor_get_volumes:
918 * @volume_monitor: a #GVolumeMonitor.
920 * Gets a list of the volumes on the system.
921 * The returned list should be freed with g_list_free(), after
922 * its elements have been unreffed with g_object_unref().
924 * Returns: (element-type GVolume) (transfer full): a #GList of #GVolume objects.
929 * g_dbus_message_new_signal:
930 * @path: A valid object path.
931 * @interface_: A valid D-Bus interface name.
932 * @signal: A valid signal name.
934 * Creates a new #GDBusMessage for a signal emission.
936 * Returns: A #GDBusMessage. Free with g_object_unref().
942 * g_settings_bind_writable:
943 * @settings: a #GSettings object
944 * @key: the key to bind
945 * @object: (type GObject.Object): a #GObject
946 * @property: the name of a boolean property to bind
947 * @inverted: whether to 'invert' the value
949 * Create a binding between the writability of @key in the
950 * The property must be boolean; "sensitive" or "visible"
951 * properties of widgets are the most likely candidates.
952 * Writable bindings are always uni-directional; changes of the
953 * writability of the setting will be propagated to the object
954 * property, not the other way.
955 * When the @inverted argument is %TRUE, the binding inverts the
956 * value as it passes from the setting to the object, i.e. @property
957 * will be set to %TRUE if the key is <emphasis>not</emphasis>
959 * Note that the lifecycle of the binding is tied to the object,
960 * and that you can have only one binding per object property.
961 * If you bind the same property twice on the same object, the second
962 * binding overrides the first one.
969 * g_memory_input_stream_new_from_data:
970 * @data: (array length=len) (element-type guint8): input data
971 * @len: length of the data, may be -1 if @data is a nul-terminated string
972 * @destroy: (allow-none): function that is called to free @data, or %NULL
974 * Creates a new #GMemoryInputStream with data in memory of a given size.
976 * Returns: new #GInputStream read from @data of @len bytes.
981 * G_ENUM_CLASS_TYPE_NAME:
982 * @class: a #GEnumClass
984 * Get the static type name from a given #GEnumClass structure.
986 * Returns: the type name.
992 * @buffer: Pointer to a buffer where data will be written.
993 * @size: the available size in @buffer.
995 * Structure used for scatter/gather data input.
996 * You generally pass in an array of #GInputVector<!-- -->s
997 * and the operation will store the read data starting in the
998 * first buffer, switching to the next as needed.
1005 * g_socket_connection_get_socket:
1006 * @connection: a #GSocketConnection
1008 * Gets the underlying #GSocket object of the connection.
1009 * This can be useful if you want to do something unusual on it
1010 * not supported by the #GSocketConnection APIs.
1012 * Returns: (transfer none): a #GSocketAddress or %NULL on error.
1018 * g_input_stream_is_closed:
1019 * @stream: input stream.
1021 * Checks if an input stream is closed.
1023 * Returns: %TRUE if the stream is closed.
1028 * g_credentials_get_native: (skip)
1029 * @credentials: A #GCredentials.
1030 * @native_type: The type of native credentials to get.
1032 * Gets a pointer to native credentials of type @native_type from
1033 * It is a programming error (which will cause an warning to be
1034 * logged) to use this method if there is no #GCredentials support for
1035 * the OS or if @native_type isn't supported by the OS.
1036 * operation there is no #GCredentials support for the OS or if
1037 * data, it is owned by @credentials.
1039 * Returns: The pointer to native credentials or %NULL if the
1045 * G_TYPE_PARAM_UCHAR:
1047 * The #GType of #GParamSpecUChar.
1052 * G_TYPE_PARAM_POINTER:
1054 * The #GType of #GParamSpecPointer.
1059 * g_file_replace_contents:
1060 * @file: input #GFile.
1061 * @contents: a string containing the new contents for @file.
1062 * @length: the length of @contents in bytes.
1063 * @etag: (allow-none): the old <link linkend="gfile-etag">entity tag</link> for the document, or %NULL
1064 * @make_backup: %TRUE if a backup should be created.
1065 * @flags: a set of #GFileCreateFlags.
1066 * @new_etag: (allow-none) (out): a location to a new <link linkend="gfile-etag">entity tag</link> for the document. This should be freed with g_free() when no longer needed, or %NULL
1067 * @cancellable: optional #GCancellable object, %NULL to ignore.
1068 * @error: a #GError, or %NULL
1070 * Replaces the contents of @file with @contents of @length bytes.
1071 * If @etag is specified (not %NULL) any existing file must have that etag, or
1072 * the error %G_IO_ERROR_WRONG_ETAG will be returned.
1073 * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
1074 * If @cancellable is not %NULL, then the operation can be cancelled by
1075 * triggering the cancellable object from another thread. If the operation
1076 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1077 * The returned @new_etag can be used to verify that the file hasn't changed the
1078 * next time it is saved over.
1079 * has occurred, this function will return %FALSE and set @error
1080 * appropriately if present.
1082 * Returns: %TRUE if successful. If an error
1087 * g_inet_address_to_bytes: (skip)
1088 * @address: a #GInetAddress
1090 * Gets the raw binary address data from @address.
1091 * which should not be modified, stored, or freed. The size of this
1092 * array can be gotten with g_inet_address_get_native_size().
1094 * Returns: a pointer to an internal array of the bytes in @address,
1100 * G_TYPE_HASH_TABLE:
1102 * The #GType for a boxed type holding a #GHashTable reference.
1110 * @file: input #GFile.
1112 * Gets the local pathname for #GFile, if one exists.
1113 * This call does no blocking i/o.
1114 * no such path exists. The returned string should be
1115 * freed with g_free() when no longer needed.
1117 * Returns: string containing the #GFile's path, or %NULL if
1123 * @G_IO_ERROR_FAILED: Generic error condition for when any operation fails.
1124 * @G_IO_ERROR_NOT_FOUND: File not found error.
1125 * @G_IO_ERROR_EXISTS: File already exists error.
1126 * @G_IO_ERROR_IS_DIRECTORY: File is a directory error.
1127 * @G_IO_ERROR_NOT_DIRECTORY: File is not a directory.
1128 * @G_IO_ERROR_NOT_EMPTY: File is a directory that isn't empty.
1129 * @G_IO_ERROR_NOT_REGULAR_FILE: File is not a regular file.
1130 * @G_IO_ERROR_NOT_SYMBOLIC_LINK: File is not a symbolic link.
1131 * @G_IO_ERROR_NOT_MOUNTABLE_FILE: File cannot be mounted.
1132 * @G_IO_ERROR_FILENAME_TOO_LONG: Filename is too many characters.
1133 * @G_IO_ERROR_INVALID_FILENAME: Filename is invalid or contains invalid characters.
1134 * @G_IO_ERROR_TOO_MANY_LINKS: File contains too many symbolic links.
1135 * @G_IO_ERROR_NO_SPACE: No space left on drive.
1136 * @G_IO_ERROR_INVALID_ARGUMENT: Invalid argument.
1137 * @G_IO_ERROR_PERMISSION_DENIED: Permission denied.
1138 * @G_IO_ERROR_NOT_SUPPORTED: Operation not supported for the current backend.
1139 * @G_IO_ERROR_NOT_MOUNTED: File isn't mounted.
1140 * @G_IO_ERROR_ALREADY_MOUNTED: File is already mounted.
1141 * @G_IO_ERROR_CLOSED: File was closed.
1142 * @G_IO_ERROR_CANCELLED: Operation was cancelled. See #GCancellable.
1143 * @G_IO_ERROR_PENDING: Operations are still pending.
1144 * @G_IO_ERROR_READ_ONLY: File is read only.
1145 * @G_IO_ERROR_CANT_CREATE_BACKUP: Backup couldn't be created.
1146 * @G_IO_ERROR_WRONG_ETAG: File's Entity Tag was incorrect.
1147 * @G_IO_ERROR_TIMED_OUT: Operation timed out.
1148 * @G_IO_ERROR_WOULD_RECURSE: Operation would be recursive.
1149 * @G_IO_ERROR_BUSY: File is busy.
1150 * @G_IO_ERROR_WOULD_BLOCK: Operation would block.
1151 * @G_IO_ERROR_HOST_NOT_FOUND: Host couldn't be found (remote operations).
1152 * @G_IO_ERROR_WOULD_MERGE: Operation would merge files.
1153 * @G_IO_ERROR_FAILED_HANDLED: Operation failed and a helper program has already interacted with the user. Do not display any error dialog.
1154 * @G_IO_ERROR_TOO_MANY_OPEN_FILES: The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. Since 2.20
1155 * @G_IO_ERROR_NOT_INITIALIZED: The object has not been initialized. Since 2.22
1156 * @G_IO_ERROR_ADDRESS_IN_USE: The requested address is already in use. Since 2.22
1157 * @G_IO_ERROR_PARTIAL_INPUT: Need more input to finish operation. Since 2.24
1158 * @G_IO_ERROR_INVALID_DATA: There input data was invalid. Since 2.24
1159 * @G_IO_ERROR_DBUS_ERROR: A remote object generated an error that doesn't correspond to a locally registered #GError error domain. Use g_dbus_error_get_remote_error() to extract the D-Bus error name and g_dbus_error_strip_remote_error() to fix up the message so it matches what was received on the wire. Since 2.26.
1160 * @G_IO_ERROR_HOST_UNREACHABLE: Host unreachable. Since 2.26
1161 * @G_IO_ERROR_NETWORK_UNREACHABLE: Network unreachable. Since 2.26
1162 * @G_IO_ERROR_CONNECTION_REFUSED: Connection refused. Since 2.26
1163 * @G_IO_ERROR_PROXY_FAILED: Connection to proxy server failed. Since 2.26
1164 * @G_IO_ERROR_PROXY_AUTH_FAILED: Proxy authentication failed. Since 2.26
1165 * @G_IO_ERROR_PROXY_NEED_AUTH: Proxy server needs authentication. Since 2.26
1166 * @G_IO_ERROR_PROXY_NOT_ALLOWED: Proxy connection is not allowed by ruleset. Since 2.26
1168 * Error codes returned by GIO functions.
1173 * g_file_input_stream_query_info:
1174 * @stream: a #GFileInputStream.
1175 * @attributes: a file attribute query string.
1176 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1177 * @error: a #GError location to store the error occuring, or %NULL to ignore.
1179 * Queries a file input stream the given @attributes. This function blocks
1180 * while querying the stream. For the asynchronous (non-blocking) version
1181 * of this function, see g_file_input_stream_query_info_async(). While the
1182 * stream is blocked, the stream will set the pending flag internally, and
1183 * any other operations on the stream will fail with %G_IO_ERROR_PENDING.
1185 * Returns: (transfer full): a #GFileInfo, or %NULL on error.
1190 * G_IS_PARAM_SPEC_ENUM:
1191 * @pspec: a valid #GParamSpec instance
1193 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM.
1195 * Returns: %TRUE on success.
1200 * G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME:
1202 * A key in the "standard" namespace for getting the display name of the file.
1203 * A display name is guaranteed to be in UTF8 and can thus be displayed in
1205 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
1210 * g_permission_acquire_finish:
1211 * @permission: a #GPermission instance
1212 * @result: the #GAsyncResult given to the #GAsyncReadyCallback
1213 * @error: a pointer to a %NULL #GError, or %NULL
1214 * @returns: %TRUE if the permission was successfully acquired
1216 * Collects the result of attempting to acquire the permission
1217 * represented by @permission.
1218 * This is the second half of the asynchronous version of
1219 * g_permission_acquire().
1228 * The fundamental type from which all interfaces are derived.
1233 * g_file_mount_enclosing_volume_finish:
1234 * @location: input #GFile.
1235 * @result: a #GAsyncResult.
1236 * @error: a #GError, or %NULL
1238 * Finishes a mount operation started by g_file_mount_enclosing_volume().
1239 * has occurred, this function will return %FALSE and set @error
1240 * appropriately if present.
1242 * Returns: %TRUE if successful. If an error
1247 * g_application_id_is_valid:
1248 * @application_id: a potential application identifier
1249 * @returns: %TRUE if @application_id is valid
1251 * Checks if @application_id is a valid application identifier.
1252 * A valid ID is required for calls to g_application_new() and
1253 * g_application_set_application_id().
1254 * For convenience, the restrictions on application identifiers are
1257 * <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-" and must not begin with a digit.</listitem>
1258 * <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least two elements).</listitem>
1259 * <listitem>Application identifiers must not begin with a '.' (period) character.</listitem>
1260 * <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
1261 * <listitem>Application identifiers must not exceed 255 characters.</listitem>
1267 * g_resolver_lookup_service_async:
1268 * @resolver: a #GResolver
1269 * @service: the service type to look up (eg, "ldap")
1270 * @protocol: the networking protocol to use for @service (eg, "tcp")
1271 * @domain: the DNS domain to look up the service in
1272 * @cancellable: (allow-none): a #GCancellable, or %NULL
1273 * @callback: (scope async): callback to call after resolution completes
1274 * @user_data: (closure): data for @callback
1276 * Begins asynchronously performing a DNS SRV lookup for the given
1277 * get the final result. See g_resolver_lookup_service() for more
1285 * g_proxy_resolver_lookup:
1286 * @resolver: a #GProxyResolver
1287 * @uri: a URI representing the destination to connect to
1288 * @cancellable: (allow-none): a #GCancellable, or %NULL
1289 * @error: return location for a #GError, or %NULL
1291 * Looks into the system proxy configuration to determine what proxy,
1292 * if any, to use to connect to @uri. The returned proxy URIs are of the
1293 * form <literal><protocol>://[user[:password]@]host:port</literal>
1294 * or <literal>direct://</literal>, where <protocol> could be
1295 * http, rtsp, socks or other proxying protocol.
1296 * If you don't know what network protocol is being used on the
1297 * socket, you should use <literal>none</literal> as the URI protocol.
1298 * In this case, the resolver might still return a generic proxy type
1299 * (such as SOCKS), but would not return protocol-specific proxy types
1301 * <literal>direct://</literal> is used when no proxy is needed.
1302 * Direct connection should not be attempted unless it is part of the
1303 * returned array of proxies.
1304 * NULL-terminated array of proxy URIs. Must be freed
1305 * with g_strfreev().
1307 * Returns: (transfer full) (array zero-terminated=1): A
1313 * g_data_output_stream_new:
1314 * @base_stream: a #GOutputStream.
1316 * Creates a new data output stream for @base_stream.
1318 * Returns: #GDataOutputStream.
1323 * SECTION:gpollableinputstrea:
1324 * @short_description: Interface for pollable input streams
1325 * @include: gio/gio.h
1326 * @see_also: #GInputStream, #GPollableOutputStream, #GFileDescriptorBased
1328 * #GPollableInputStream is implemented by #GInputStream<!-- -->s that
1329 * can be polled for readiness to read. This can be used when
1330 * interfacing with a non-GIO API that expects
1331 * UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.
1339 * @parent_instance: private #GParamSpec portion
1340 * @default_value: default value for the property specified
1341 * @cset_first: a string containing the allowed values for the first byte
1342 * @cset_nth: a string containing the allowed values for the subsequent bytes
1343 * @substitutor: the replacement byte for bytes which don't match @cset_first or @cset_nth.
1344 * @null_fold_if_empty: replace empty string by %NULL
1345 * @ensure_non_null: replace %NULL strings by an empty string
1347 * A #GParamSpec derived structure that contains the meta data for string
1353 * g_file_make_director:
1354 * @file: input #GFile.
1355 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1356 * @error: a #GError, or %NULL
1358 * Creates a directory. Note that this will only create a child directory of
1359 * the immediate parent directory of the path or URI given by the #GFile. To
1360 * recursively create directories, see g_file_make_directory_with_parents().
1361 * This function will fail if the parent directory does not exist, setting
1362 * directories, this function will fail, setting @error to
1363 * %G_IO_ERROR_NOT_SUPPORTED.
1364 * For a local #GFile the newly created directory will have the default
1365 * (current) ownership and permissions of the current process.
1366 * If @cancellable is not %NULL, then the operation can be cancelled by
1367 * triggering the cancellable object from another thread. If the operation
1368 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1370 * Returns: %TRUE on successful creation, %FALSE otherwise.
1375 * g_zlib_compressor_set_file_info:
1376 * @compressor: a #GZlibCompressor
1377 * @file_info: (allow-none): a #GFileInfo
1379 * Sets @file_info in @compressor. If non-%NULL, and @compressor's
1380 * #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
1381 * it will be used to set the file name and modification time in
1382 * the GZIP header of the compressed data.
1383 * progress; it may only be called immediately after creation of @compressor,
1384 * or after resetting it with g_converter_reset().
1386 * Note: it is an error to call this function while a compression is in
1392 * g_cancellable_make_pollfd:
1393 * @cancellable: a #GCancellable or %NULL
1394 * @pollfd: a pointer to a #GPollFD
1396 * Creates a #GPollFD corresponding to @cancellable; this can be passed
1397 * to g_poll() and used to poll for cancellation. This is useful both
1398 * for unix systems without a native poll and for portability to
1400 * When this function returns %TRUE, you should use
1401 * g_cancellable_release_fd() to free up resources allocated for the
1402 * If this function returns %FALSE, either no @cancellable was given or
1403 * resource limits prevent this function from allocating the necessary
1404 * structures for polling. (On Linux, you will likely have reached
1405 * the maximum number of file descriptors.) The suggested way to handle
1406 * these cases is to ignore the @cancellable.
1407 * You are not supposed to read from the fd yourself, just check for
1408 * readable status. Reading to unset the readable status is done
1409 * with g_cancellable_reset().
1410 * failure to prepare the cancellable.
1412 * Returns: %TRUE if @pollfd was successfully initialized, %FALSE on
1418 * g_file_icon_get_file:
1421 * Gets the #GFile associated with the given @icon.
1423 * Returns: (transfer none): a #GFile, or %NULL.
1430 * A helper class for handling accepting incomming connections in the
1438 * G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME:
1440 * A key in the "access" namespace for checking renaming privileges.
1441 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
1442 * This attribute will be %TRUE if the user is able to rename the file.
1448 * @seekable: a #GSeekable.
1449 * @offset: a #goffset.
1450 * @type: a #GSeekType.
1451 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1452 * @error: a #GError location to store the error occuring, or %NULL to ignore.
1454 * Seeks in the stream by the given @offset, modified by @type.
1455 * If @cancellable is not %NULL, then the operation can be cancelled by
1456 * triggering the cancellable object from another thread. If the operation
1457 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1458 * has occurred, this function will return %FALSE and set @error
1459 * appropriately if present.
1461 * Returns: %TRUE if successful. If an error
1466 * G_TYPE_IS_INTERFACE:
1467 * @type: A #GType value.
1469 * Checks if @type is an interface type.
1470 * An interface type provides a pure API, the implementation
1471 * of which is provided by another type (which is then said to conform
1472 * to the interface). GLib interfaces are somewhat analogous to Java
1473 * interfaces and C++ classes containing only pure virtual functions,
1474 * with the difference that GType interfaces are not derivable (but see
1475 * g_type_interface_add_prerequisite() for an alternative).
1477 * Returns: %TRUE on success.
1482 * GDBusSubtreeVTable:
1483 * @enumerate: Function for enumerating child nodes.
1484 * @introspect: Function for introspecting a child node.
1485 * @dispatch: Function for dispatching a remote call on a child node.
1487 * Virtual table for handling subtrees registered with g_dbus_connection_register_subtree().
1494 * SECTION:gcontenttyp:
1495 * @short_description: Platform-specific content typing
1496 * @include: gio/gio.h
1498 * A content type is a platform specific string that defines the type
1499 * of a file. On unix it is a mime type, on win32 it is an extension string
1500 * like ".doc", ".txt" or a percieved string like "audio". Such strings
1501 * can be looked up in the registry at HKEY_CLASSES_ROOT.
1506 * GDBusConnection:locked:
1508 * A boolean specifying whether the message is locked.
1515 * g_dbus_proxy_call_finish:
1516 * @proxy: A #GDBusProxy.
1517 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().
1518 * @error: Return location for error or %NULL.
1520 * Finishes an operation started with g_dbus_proxy_call().
1521 * return values. Free with g_variant_unref().
1523 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
1529 * g_socket_client_get_timeout:
1530 * @client: a #GSocketClient
1532 * Gets the I/O timeout time for sockets created by @client.
1533 * See g_socket_client_set_timeout() for details.
1535 * Returns: the timeout in seconds
1541 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT:
1543 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected.
1544 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
1549 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT:
1551 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable.
1552 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
1557 * g_socket_address_to_native:
1558 * @address: a #GSocketAddress
1559 * @dest: a pointer to a memory location that will contain the native <type>struct sockaddr</type>.
1560 * @destlen: the size of @dest. Must be at least as large as g_socket_address_get_native_size().
1561 * @error: #GError for error reporting, or %NULL to ignore.
1563 * Converts a #GSocketAddress to a native <type>struct
1564 * sockaddr</type>, which can be passed to low-level functions like
1565 * connect() or bind().
1566 * If not enough space is availible, a %G_IO_ERROR_NO_SPACE error is
1567 * returned. If the address type is not known on the system
1568 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
1570 * Returns: %TRUE if @dest was filled in, %FALSE on error
1576 * g_bus_own_name_on_connection_with_closures:
1577 * @connection: A #GDBusConnection.
1578 * @name: The well-known name to own.
1579 * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
1580 * @name_acquired_closure: (allow-none): #GClosure to invoke when @name is acquired or %NULL.
1581 * @name_lost_closure: (allow-none): #GClosure to invoke when @name is lost or %NULL.
1583 * Version of g_bus_own_name_on_connection() using closures instead of callbacks for
1584 * easier binding in other languages.
1585 * g_bus_unown_name() to stop owning the name.
1587 * Returns: An identifier (never 0) that an be used with
1588 * Rename to: g_bus_own_name_on_connection
1594 * g_socket_client_connect:
1595 * @client: a #GSocketClient.
1596 * @connectable: a #GSocketConnectable specifying the remote address.
1597 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1598 * @error: #GError for error reporting, or %NULL to ignore.
1600 * Tries to resolve the @connectable and make a network connection to it..
1601 * Upon a successful connection, a new #GSocketConnection is constructed
1602 * and returned. The caller owns this new object and must drop their
1603 * reference to it when finished with it.
1604 * The type of the #GSocketConnection object returned depends on the type of
1605 * the underlying socket that is used. For instance, for a TCP/IP connection
1606 * it will be a #GTcpConnection.
1607 * The socket created will be the same family as the the address that the
1608 * or indirectly via g_socket_client_set_local_address(). The socket type
1609 * defaults to %G_SOCKET_TYPE_STREAM but can be set with
1610 * g_socket_client_set_socket_type().
1611 * If a local address is specified with g_socket_client_set_local_address() the
1612 * socket will be bound to this address before connecting.
1614 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
1620 * g_settings_unbind:
1621 * @object: the object
1622 * @property: the property whose binding is removed
1624 * Removes an existing binding for @property on @object.
1625 * Note that bindings are automatically removed when the
1626 * object is finalized, so it is rarely necessary to call this
1635 * @g_iface: The parent interface.
1636 * @tell: Tells the current location within a stream.
1637 * @can_seek: Checks if seeking is supported by the stream.
1638 * @seek: Seeks to a location within a stream.
1639 * @can_truncate: Chekcs if truncation is suppored by the stream.
1640 * @truncate_fn: Truncates a stream.
1642 * Provides an interface for implementing seekable functionality on I/O Streams.
1647 * G_TYPE_PARAM_FLAGS:
1649 * The #GType of #GParamSpecFlags.
1654 * g_file_input_stream_query_info_finish:
1655 * @stream: a #GFileInputStream.
1656 * @result: a #GAsyncResult.
1657 * @error: a #GError location to store the error occuring, or %NULL to ignore.
1659 * Finishes an asynchronous info query operation.
1661 * Returns: (transfer full): #GFileInfo.
1666 * GInetAddress:is-mc-link-local:
1668 * Whether this is a link-local multicast address.
1669 * See g_inet_address_get_is_mc_link_local().
1676 * GUnixCredentialsMessage:credentials:
1678 * The credentials stored in the message.
1685 * g_mount_is_shadowed:
1686 * @mount: A #GMount.
1688 * Determines if @mount is shadowed. Applications or libraries should
1689 * avoid displaying @mount in the user interface if it is shadowed.
1690 * A mount is said to be shadowed if there exists one or more user
1691 * visible objects (currently #GMount objects) with a root that is
1692 * inside the root of @mount.
1693 * One application of shadow mounts is when exposing a single file
1694 * system that is used to address several logical volumes. In this
1695 * situation, a #GVolumeMonitor implementation would create two
1696 * #GVolume objects (for example, one for the camera functionality of
1697 * the device and one for a SD card reader on the device) with
1698 * activation URIs <literal>gphoto2://[usb:001,002]/store1/</literal>
1699 * and <literal>gphoto2://[usb:001,002]/store2/</literal>. When the
1700 * underlying mount (with root
1701 * <literal>gphoto2://[usb:001,002]/</literal>) is mounted, said
1702 * #GVolumeMonitor implementation would create two #GMount objects
1703 * (each with their root matching the corresponding volume activation
1704 * root) that would shadow the original mount.
1705 * The proxy monitor in GVfs 2.26 and later, automatically creates and
1706 * manage shadow mounts (and shadows the underlying mount) if the
1707 * activation root on a #GVolume is set.
1709 * Returns: %TRUE if @mount is shadowed.
1716 * @ref_count: The reference count or -1 if statically allocated.
1717 * @name: The name of the D-Bus method, e.g. @RequestName.
1718 * @in_args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no in arguments.
1719 * @out_args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no out arguments.
1720 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
1722 * Information about a method on an D-Bus interface.
1729 * G_TYPE_INITIALLY_UNOWNED:
1731 * The type for #GInitiallyUnowned.
1736 * g_io_scheduler_push_job:
1737 * @job_func: a #GIOSchedulerJobFunc.
1738 * @user_data: data to pass to @job_func
1739 * @notify: a #GDestroyNotify for @user_data, or %NULL
1740 * @io_priority: the <link linkend="gioscheduler">I/O priority</link> of the request.
1741 * @cancellable: optional #GCancellable object, %NULL to ignore.
1743 * Schedules the I/O job to run.
1744 * regardless whether the job was cancelled or has run to completion.
1745 * If @cancellable is not %NULL, it can be used to cancel the I/O job
1746 * by calling g_cancellable_cancel() or by calling
1747 * g_io_scheduler_cancel_all_jobs().
1752 * GIOSchedulerJobFunc:
1753 * @job: a #GIOSchedulerJob.
1754 * @cancellable: optional #GCancellable object, %NULL to ignore.
1755 * @user_data: the data to pass to callback function
1758 * Note that depending on whether threads are available, the
1759 * #GIOScheduler may run jobs in separate threads or in an idle
1761 * Long-running jobs should periodically check the @cancellable
1762 * to see if they have been cancelled.
1763 * complete the job, %FALSE if the job is complete (or cancelled)
1765 * Returns: %TRUE if this function should be called again to
1770 * g_dbus_message_set_serial:
1771 * @message: A #GDBusMessage.
1772 * @serial: A #guint32.
1774 * Sets the serial for @message.
1781 * g_dbus_auth_observer_authorize_authenticated_peer:
1782 * @observer: A #GDBusAuthObserver.
1783 * @stream: A #GIOStream for the #GDBusConnection.
1784 * @credentials: Credentials received from the peer or %NULL.
1786 * Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer.
1788 * Returns: %TRUE if the peer is authorized, %FALSE if not.
1795 * @interface_init: location of the interface initialization function
1796 * @interface_finalize: location of the interface finalization function
1797 * @interface_data: user-supplied data passed to the interface init/finalize functions
1799 * A structure that provides information to the type system which is
1800 * used specifically for managing interface types.
1805 * g_io_stream_get_output_stream:
1806 * @stream: a #GIOStream
1808 * Gets the output stream for this object. This is used for
1812 * Returns: (transfer none): a #GOutputStream, owned by the #GIOStream.
1818 * G_PARAM_READWRITE:
1820 * #GParamFlags value alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE.
1827 * Opaque mountable volume object.
1832 * g_file_query_settable_attributes:
1833 * @file: input #GFile.
1834 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1835 * @error: a #GError, or %NULL
1837 * Obtain the list of settable attributes for the file.
1838 * Returns the type and full attribute name of all the attributes
1839 * that can be set on this file. This doesn't mean setting it will always
1840 * succeed though, you might get an access failure, or some specific
1841 * file may not support a specific attribute.
1842 * If @cancellable is not %NULL, then the operation can be cancelled by
1843 * triggering the cancellable object from another thread. If the operation
1844 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1845 * When you are done with it, release it with g_file_attribute_info_list_unref()
1847 * Returns: a #GFileAttributeInfoList describing the settable attributes.
1852 * G_VALUE_HOLDS_POINTER:
1853 * @value: a valid #GValue structure
1855 * Checks whether the given #GValue can hold values of type %G_TYPE_POINTER.
1857 * Returns: %TRUE on success.
1862 * GActionGroup::action-added:
1863 * @action_group: the #GActionGroup that changed
1864 * @action_name: the name of the action in @action_group
1866 * Signals that a new action was just added to the group. This signal
1867 * is emitted after the action has been added and is now visible.
1874 * GWin32InputStream:close-handle:
1876 * Whether to close the file handle when the stream is closed.
1884 * @malloc: function to use for allocating memory.
1885 * @realloc: function to use for reallocating memory.
1886 * @free: function to use to free memory.
1887 * @calloc: function to use for allocating zero-filled memory.
1888 * @try_malloc: function to use for allocating memory without a default error handler.
1889 * @try_realloc: function to use for reallocating memory without a default error handler.
1891 * A set of functions used to perform memory allocation. The same #GMemVTable must
1892 * be used for all allocations in the same program; a call to g_mem_set_vtable(),
1893 * if it exists, should be prior to any use of GLib.
1898 * g_socket_listener_set_backlog:
1899 * @listener: a #GSocketListener
1900 * @listen_backlog: an integer
1902 * Sets the listen backlog on the sockets in the listener.
1903 * See g_socket_set_listen_backlog() for details
1910 * GFilenameCompleter::got-completion-data:
1912 * Emitted when the file name completion information comes available.
1917 * g_dbus_connection_flush_finish:
1918 * @connection: A #GDBusConnection.
1919 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().
1920 * @error: Return location for error or %NULL.
1922 * Finishes an operation started with g_dbus_connection_flush().
1924 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1930 * g_dbus_method_invocation_get_message:
1931 * @invocation: A #GDBusMethodInvocation.
1933 * Gets the #GDBusMessage for the method invocation. This is useful if
1934 * you need to use low-level protocol features, such as UNIX file
1935 * descriptor passing, that cannot be properly expressed in the
1937 * See <xref linkend="gdbus-server"/> and <xref
1938 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1939 * low-level API to send and receive UNIX file descriptors.
1941 * Returns: (transfer none): #GDBusMessage. Do not free, it is owned by @invocation.
1947 * GParamSpecBoolean:
1948 * @parent_instance: private #GParamSpec portion
1949 * @default_value: default value for the property specified
1951 * A #GParamSpec derived structure that contains the meta data for boolean properties.
1956 * g_socket_create_source: (skip)
1957 * @socket: a #GSocket
1958 * @condition: a #GIOCondition mask to monitor
1959 * @cancellable: (allow-none): a %GCancellable or %NULL
1961 * Creates a %GSource that can be attached to a %GMainContext to monitor
1962 * for the availibility of the specified @condition on the socket.
1963 * The callback on the source is of the #GSocketSourceFunc type.
1964 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition;
1965 * these conditions will always be reported output if they are true.
1966 * cause the source to trigger, reporting the current condition (which
1967 * is likely 0 unless cancellation happened at the same time as a
1968 * condition change). You can check for this in the callback using
1969 * g_cancellable_is_cancelled().
1970 * If @socket has a timeout set, and it is reached before @condition
1971 * occurs, the source will then trigger anyway, reporting %G_IO_IN or
1972 * %G_IO_OUT depending on @condition. However, @socket will have been
1973 * marked as having had a timeout, and so the next #GSocket I/O method
1974 * you call will then fail with a %G_IO_ERROR_TIMED_OUT.
1976 * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref().
1982 * GTlsCertificate:private-key-pem:
1984 * The PEM (ASCII) encoded representation of the certificate's
1985 * private key. This property (or the #GTlsCertificate:private-key
1986 * property) can be set when constructing a key (eg, from a file),
1987 * but cannot be read.
1995 * @g_iface: The parent interface.
1996 * @init: Initializes the object.
1998 * Provides an interface for initializing object such that initialization
2008 * Virtual File System object.
2013 * G_IS_PARAM_SPEC_INT:
2014 * @pspec: a valid #GParamSpec instance
2016 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT.
2018 * Returns: %TRUE on success.
2023 * GSignalEmissionHook:
2024 * @ihint: Signal invocation hint, see #GSignalInvocationHint.
2025 * @n_param_values: the number of parameters to the function, including the instance on which the signal was emitted.
2026 * @param_values: the instance on which the signal was emitted, followed by the parameters of the emission.
2027 * @data: user data associated with the hook.
2029 * A simple function pointer to get invoked when the signal is emitted. This
2030 * allows you to tie a hook to the signal type, so that it will trap all
2031 * emissions of that signal, from any object.
2032 * You may not attach these to signals created with the #G_SIGNAL_NO_HOOKS flag.
2033 * hook is disconnected (and destroyed).
2035 * Returns: whether it wants to stay connected. If it returns %FALSE, the signal
2042 * <structname>GBinding</structname> is an opaque structure whose members
2043 * cannot be accessed directly.
2050 * GSettingsBindSetMapping:
2051 * @value: a #GValue containing the property value to map
2052 * @expected_type: the #GVariantType to create
2053 * @user_data: user data that was specified when the binding was created
2054 * @returns: a new #GVariant holding the data from @value, or %NULL in case of an error
2056 * The type for the function that is used to convert an object property
2057 * value to a #GVariant for storing it in #GSettings.
2064 * Error domain for #GResolver. Errors in this domain will be from the
2065 * #GResolverError enumeration. See #GError for more information on
2071 * g_file_attribute_matcher_enumerate_namespace:
2072 * @matcher: a #GFileAttributeMatcher.
2073 * @ns: a string containing a file attribute namespace.
2075 * Checks if the matcher will match all of the keys in a given namespace.
2076 * This will always return %TRUE if a wildcard character is in use (e.g. if
2077 * matcher was created with "standard::*" and @ns is "standard", or if matcher was created
2078 * using "*" and namespace is anything.)
2079 * in the given @ns, %FALSE otherwise.
2081 * Todo: this is awkwardly worded.
2082 * Returns: %TRUE if the matcher matches all of the entries
2087 * g_simple_async_result_get_op_res_gboolean:
2088 * @simple: a #GSimpleAsyncResult.
2090 * Gets the operation result boolean from within the asynchronous result.
2091 * if the operation's result was %FALSE.
2093 * Returns: %TRUE if the operation's result was %TRUE, %FALSE
2099 * @G_DBUS_SERVER_FLAGS_NONE: No flags set.
2100 * @G_DBUS_SERVER_FLAGS_RUN_IN_THREAD: All #GDBusServer::new-connection signals will run in separated dedicated threads (see signal for details).
2101 * @G_DBUS_SERVER_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS: Allow the anonymous authentication method.
2103 * Flags used when creating a #GDBusServer.
2110 * SECTION:gnetworkaddres:
2111 * @short_description: A GSocketConnectable for resolving hostnames
2112 * @include: gio/gio.h
2114 * #GNetworkAddress provides an easy way to resolve a hostname and
2115 * then attempt to connect to that host, handling the possibility of
2116 * multiple IP addresses and multiple address families.
2117 * See #GSocketConnectable for and example of using the connectable
2123 * g_application_get_is_remote:
2124 * @application: a #GApplication
2125 * @returns: %TRUE if @application is remote
2127 * Checks if @application is remote.
2128 * If @application is remote then it means that another instance of
2129 * application already exists (the 'primary' instance). Calls to
2130 * perform actions on @application will result in the actions being
2131 * performed by the primary instance.
2132 * The value of this property can not be accessed before
2133 * g_application_register() has been called. See
2134 * g_application_get_is_registered().
2141 * g_tls_client_connection_set_server_identity:
2142 * @conn: the #GTlsClientConnection
2143 * @identity: a #GSocketConnectable describing the expected server identity
2145 * Sets @conn's expected server identity, which is used both to tell
2146 * servers on virtual hosts which certificate to present, and also
2147 * to let @conn know what name to look for in the certificate when
2148 * performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled.
2157 * Error domain for option parsing. Errors in this domain will
2158 * be from the #GOptionError enumeration. See #GError for information on
2164 * GVolumeMonitor::drive-changed:
2165 * @volume_monitor: The volume monitor emitting the signal.
2166 * @drive: the drive that changed
2168 * Emitted when a drive changes.
2173 * G_VALUE_HOLDS_BOOLEAN:
2174 * @value: a valid #GValue structure
2176 * Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN.
2178 * Returns: %TRUE on success.
2185 * A handle to an object implementing the #GMountIface interface.
2191 * @G_DBUS_CALL_FLAGS_NONE: No flags set.
2192 * @G_DBUS_CALL_FLAGS_NO_AUTO_START: The bus must not launch an owner for the destination name in response to this method invocation.
2194 * Flags used in g_dbus_connection_call() and similar APIs.
2201 * G_VARIANT_TYPE_SIGNATURE:
2203 * The type of a DBus type signature. These are strings of a specific
2204 * format used as type signatures for DBus methods and messages.
2205 * If you are not interacting with DBus, then there is no reason to make
2206 * use of this type. If you are, then the DBus specification contains a
2207 * precise description of valid signature strings.
2212 * g_credentials_get_unix_user:
2213 * @credentials: A #GCredentials
2214 * @error: Return location for error or %NULL.
2216 * Tries to get the UNIX user identifier from @credentials. This
2217 * method is only available on UNIX platforms.
2218 * This operation can fail if #GCredentials is not supported on the
2219 * OS or if the native credentials type does not contain information
2220 * about the UNIX user.
2222 * Returns: The UNIX user identifier or -1 if @error is set.
2228 * SECTION:gemblemedico:
2229 * @short_description: Icon with emblems
2230 * @include: gio/gio.h
2231 * @see_also: #GIcon, #GLoadableIcon, #GThemedIcon, #GEmblem
2233 * #GEmblemedIcon is an implementation of #GIcon that supports
2234 * adding an emblem to an icon. Adding multiple emblems to an
2235 * icon is ensured via g_emblemed_icon_add_emblem().
2236 * Note that #GEmblemedIcon allows no control over the position
2237 * of the emblems. See also #GEmblem for more information.
2242 * g_file_enumerator_set_pending:
2243 * @enumerator: a #GFileEnumerator.
2244 * @pending: a boolean value.
2246 * Sets the file enumerator as having pending operations.
2251 * g_dbus_proxy_get_default_timeout:
2252 * @proxy: A #GDBusProxy.
2254 * Gets the timeout to use if -1 (specifying default timeout) is
2255 * passed as @timeout_msec in the g_dbus_proxy_call() and
2256 * g_dbus_proxy_call_sync() functions.
2257 * See the #GDBusProxy:g-default-timeout property for more details.
2259 * Returns: Timeout to use for @proxy.
2265 * g_application_release:
2266 * @application: a #GApplication
2268 * Decrease the use count of @application.
2269 * When the use count reaches zero, the application will stop running.
2270 * Never call this function except to cancel the effect of a previous
2271 * call to g_application_hold().
2276 * GSocketService::incoming:
2277 * @service: the #GSocketService.
2278 * @connection: a new #GSocketConnection object.
2279 * @source_object: the source_object passed to g_socket_listener_add_address().
2281 * The ::incoming signal is emitted when a new incoming connection
2282 * to @service needs to be handled. The handler must initiate the
2283 * handling of @connection, but may not block; in essence,
2284 * asynchronous operations must be used.
2286 * Returns: %TRUE to stop other handlers from being called
2292 * g_io_error_from_errno:
2293 * @err_no: Error number as defined in errno.h.
2295 * Converts errno.h error codes into GIO error codes.
2297 * Returns: #GIOErrorEnum value for the given errno.h error number.
2302 * g_file_enumerator_get_container:
2303 * @enumerator: a #GFileEnumerator
2305 * Get the #GFile container which is being enumerated.
2307 * Returns: (transfer full): the #GFile which is being enumerated.
2313 * g_volume_monitor_adopt_orphan_mount:
2314 * @mount: a #GMount object to find a parent for
2316 * This function should be called by any #GVolumeMonitor
2317 * implementation when a new #GMount object is created that is not
2318 * associated with a #GVolume object. It must be called just before
2319 * emitting the @mount_added signal.
2320 * If the return value is not %NULL, the caller must associate the
2321 * returned #GVolume object with the #GMount. This involves returning
2322 * it in its g_mount_get_volume() implementation. The caller must
2323 * also listen for the "removed" signal on the returned object
2324 * and give up its reference when handling that signal
2325 * Similary, if implementing g_volume_monitor_adopt_orphan_mount(),
2326 * the implementor must take a reference to @mount and return it in
2327 * its g_volume_get_mount() implemented. Also, the implementor must
2328 * listen for the "unmounted" signal on @mount and give up its
2329 * reference upon handling that signal.
2330 * There are two main use cases for this function.
2331 * One is when implementing a user space file system driver that reads
2332 * blocks of a block device that is already represented by the native
2333 * volume monitor (for example a CD Audio file system driver). Such
2334 * a driver will generate its own #GMount object that needs to be
2335 * assoicated with the #GVolume object that represents the volume.
2336 * The other is for implementing a #GVolumeMonitor whose sole purpose
2337 * is to return #GVolume objects representing entries in the users
2338 * "favorite servers" list or similar.
2339 * if no wants to adopt the #GMount.
2340 * implementations should instead create shadow mounts with the URI of
2341 * the mount they intend to adopt. See the proxy volume monitor in
2342 * gvfs for an example of this. Also see g_mount_is_shadowed(),
2343 * g_mount_shadow() and g_mount_unshadow() functions.
2345 * Returns: (transfer full): the #GVolume object that is the parent for @mount or %NULL
2346 * Deprecated: 2.20: Instead of using this function, #GVolumeMonitor
2351 * g_action_get_state:
2352 * @action: a #GAction
2354 * Queries the current state of @action.
2355 * If the action is not stateful then %NULL will be returned. If the
2356 * action is stateful then the type of the return value is the type
2357 * given by g_action_get_state_type().
2358 * The return value (if non-%NULL) should be freed with
2359 * g_variant_unref() when it is no longer required.
2361 * Returns: (transfer full): the current state of the action
2367 * g_dbus_connection_emit_signal:
2368 * @connection: A #GDBusConnection.
2369 * @destination_bus_name: The unique bus name for the destination for the signal or %NULL to emit to all listeners.
2370 * @object_path: Path of remote object.
2371 * @interface_name: D-Bus interface to emit a signal on.
2372 * @signal_name: The name of the signal to emit.
2373 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
2374 * @error: Return location for error or %NULL.
2377 * If the parameters GVariant is floating, it is consumed.
2378 * This can only fail if @parameters is not compatible with the D-Bus protocol.
2380 * Returns: %TRUE unless @error is set.
2386 * G_PARAM_SPEC_BOOLEAN:
2387 * @pspec: a valid #GParamSpec instance
2389 * Cast a #GParamSpec instance into a #GParamSpecBoolean.
2394 * GParamSpecUnichar:
2395 * @parent_instance: private #GParamSpec portion
2396 * @default_value: default value for the property specified
2398 * A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.
2403 * g_emblemed_icon_add_emblem:
2404 * @emblemed: a #GEmblemedIcon
2405 * @emblem: a #GEmblem
2407 * Adds @emblem to the #GList of #GEmblem <!-- -->s.
2414 * g_tls_client_connection_get_use_ssl3:
2415 * @conn: the #GTlsClientConnection
2417 * Gets whether @conn will use SSL 3.0 rather than the
2418 * highest-supported version of TLS; see
2419 * g_tls_client_connection_set_use_ssl3().
2421 * Returns: whether @conn will use SSL 3.0
2427 * g_emblem_get_icon:
2428 * @emblem: a #GEmblem from which the icon should be extracted.
2430 * Gives back the icon from @emblem.
2431 * the emblem and should not be modified or freed.
2433 * Returns: (transfer none): a #GIcon. The returned object belongs to
2439 * SECTION:gfilemonito:
2440 * @short_description: File Monitor
2441 * @include: gio/gio.h
2443 * Monitors a file or directory for changes.
2444 * To obtain a #GFileMonitor for a file or directory, use
2445 * g_file_monitor(), g_file_monitor_file(), or
2446 * g_file_monitor_directory().
2447 * To get informed about changes to the file or directory you are
2448 * monitoring, connect to the #GFileMonitor::changed signal. The
2449 * signal will be emitted in the <link
2450 * linkend="g-main-context-push-thread-default">thread-default main
2451 * context</link> of the thread that the monitor was created in
2452 * (though if the global default main context is blocked, this may
2453 * cause notifications to be blocked even if the thread-default
2454 * context is still running).
2459 * GParamSpecPointer:
2460 * @parent_instance: private #GParamSpec portion
2462 * A #GParamSpec derived structure that contains the meta data for pointer properties.
2467 * g_dbus_node_info_ref:
2468 * @info: A #GDBusNodeInfo
2470 * If @info is statically allocated does nothing. Otherwise increases
2471 * the reference count.
2473 * Returns: The same @info.
2479 * g_action_get_enabled:
2480 * @action: a #GAction
2482 * Checks if @action is currently enabled.
2483 * An action must be enabled in order to be activated or in order to
2484 * have its state changed from outside callers.
2486 * Returns: whether the action is enabled
2492 * g_dbus_connection_new_for_address:
2493 * @address: A D-Bus address.
2494 * @flags: Flags describing how to make the connection.
2495 * @observer: A #GDBusAuthObserver or %NULL.
2496 * @cancellable: A #GCancellable or %NULL.
2497 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2498 * @user_data: The data to pass to @callback.
2500 * Asynchronously connects and sets up a D-Bus client connection for
2501 * exchanging D-Bus messages with an endpoint specified by @address
2502 * which must be in the D-Bus address format.
2503 * This constructor can only be used to initiate client-side
2504 * connections - use g_dbus_connection_new() if you need to act as the
2505 * server. In particular, @flags cannot contain the
2506 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2507 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2508 * When the operation is finished, @callback will be invoked. You can
2509 * then call g_dbus_connection_new_finish() to get the result of the
2511 * If @observer is not %NULL it may be used to control the
2512 * authentication process.
2513 * This is a asynchronous failable constructor. See
2514 * g_dbus_connection_new_for_address_sync() for the synchronous
2522 * g_drive_get_identifier:
2524 * @kind: the kind of identifier to return
2526 * Gets the identifier of the given kind for @drive.
2527 * requested identfier, or %NULL if the #GDrive
2528 * doesn't have this kind of identifier.
2530 * Returns: a newly allocated string containing the
2535 * GThreadedSocketService:
2537 * A helper class for handling accepting incomming connections in the
2538 * glib mainloop and handling them in a thread.
2545 * GMountOperation:password:
2547 * The password that is used for authentication when carrying out
2548 * the mount operation.
2553 * g_network_service_set_scheme:
2554 * @srv: a #GNetworkService
2555 * @scheme: a URI scheme
2557 * Set's the URI scheme used to resolve proxies. By default, the service name
2558 * is used as scheme.
2565 * g_win32_output_stream_new:
2566 * @handle: a Win32 file handle
2567 * @close_handle: %TRUE to close the handle when done
2569 * Creates a new #GWin32OutputStream for the given @handle.
2570 * If @close_handle, is %TRUE, the handle will be closed when the
2571 * output stream is destroyed.
2573 * Returns: a new #GOutputStream
2580 * @G_SIGNAL_MATCH_ID: The signal id must be equal.
2581 * @G_SIGNAL_MATCH_DETAIL: The signal detail be equal.
2582 * @G_SIGNAL_MATCH_CLOSURE: The closure must be the same.
2583 * @G_SIGNAL_MATCH_FUNC: The C closure callback must be the same.
2584 * @G_SIGNAL_MATCH_DATA: The closure data must be the same.
2585 * @G_SIGNAL_MATCH_UNBLOCKED: Only unblocked signals may matched.
2587 * The match types specify what g_signal_handlers_block_matched(),
2588 * g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched()
2594 * GTypeFundamentalFlags:
2595 * @G_TYPE_FLAG_CLASSED: Indicates a classed type.
2596 * @G_TYPE_FLAG_INSTANTIATABLE: Indicates an instantiable type (implies classed).
2597 * @G_TYPE_FLAG_DERIVABLE: Indicates a flat derivable type.
2598 * @G_TYPE_FLAG_DEEP_DERIVABLE: Indicates a deep derivable type (implies derivable).
2600 * Bit masks used to check or determine specific characteristics of a
2606 * g_volume_get_mount:
2607 * @volume: a #GVolume.
2609 * Gets the mount for the @volume.
2610 * The returned object should be unreffed with g_object_unref()
2611 * when no longer needed.
2613 * Returns: (transfer full): a #GMount or %NULL if @volume isn't mounted.
2620 * Opaque module base class for extending GIO.
2625 * g_unix_socket_address_new:
2626 * @path: the socket path
2628 * Creates a new #GUnixSocketAddress for @path.
2629 * To create abstract socket addresses, on systems that support that,
2630 * use g_unix_socket_address_new_abstract().
2632 * Returns: a new #GUnixSocketAddress
2638 * GMountOperation:password-save:
2640 * Determines if and how the password information should be saved.
2645 * g_pollable_output_stream_can_poll:
2646 * @stream: a #GPollableOutputStream.
2648 * Checks if @stream is actually pollable. Some classes may implement
2649 * #GPollableOutputStream but have only certain instances of that
2650 * class be pollable. If this method returns %FALSE, then the behavior
2651 * of other #GPollableOutputStream methods is undefined.
2652 * For any given stream, the value returned by this method is constant;
2653 * a stream cannot switch from pollable to non-pollable or vice versa.
2655 * Returns: %TRUE if @stream is pollable, %FALSE if not.
2661 * g_inet_address_get_is_mc_global:
2662 * @address: a #GInetAddress
2664 * Tests whether @address is a global multicast address.
2666 * Returns: %TRUE if @address is a global multicast address.
2672 * GPermission:can-acquire:
2674 * %TRUE if it is generally possible to acquire the permission by calling
2675 * g_permission_acquire().
2680 * GMemoryOutputStream:realloc-function: (skip)
2682 * Function with realloc semantics called to enlarge the buffer.
2689 * g_unix_input_stream_get_close_fd:
2690 * @stream: a #GUnixInputStream
2692 * Returns whether the file descriptor of @stream will be
2693 * closed when the stream is closed.
2695 * Returns: %TRUE if the file descriptor is closed when done
2701 * g_dbus_proxy_new_sync:
2702 * @connection: A #GDBusConnection.
2703 * @flags: Flags used when constructing the proxy.
2704 * @info: (allow-none): A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
2705 * @name: (allow-none): A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
2706 * @object_path: An object path.
2707 * @interface_name: A D-Bus interface name.
2708 * @cancellable: (allow-none): A #GCancellable or %NULL.
2709 * @error: (allow-none): Return location for error or %NULL.
2711 * Creates a proxy for accessing @interface_name on the remote object
2712 * at @object_path owned by @name at @connection and synchronously
2713 * loads D-Bus properties unless the
2714 * %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
2715 * If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
2716 * match rules for signals. Connect to the #GDBusProxy::g-signal signal
2717 * to handle signals from the remote object.
2718 * If @name is a well-known name and the
2719 * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
2720 * owner currently exists, the message bus will be requested to launch
2721 * a name owner for the name.
2722 * This is a synchronous failable constructor. See g_dbus_proxy_new()
2723 * and g_dbus_proxy_new_finish() for the asynchronous version.
2724 * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
2726 * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
2733 * @struct_type: the type of the elements to allocate
2734 * @n_structs: the number of elements to allocate
2736 * Attempts to allocate @n_structs elements of type @struct_type, initialized
2737 * to 0's, and returns %NULL on failure. Contrast with g_new0(), which aborts
2738 * the program on failure.
2739 * The returned pointer is cast to a pointer to the given type.
2740 * The function returns %NULL when @n_structs is 0 of if an overflow occurs.
2743 * Returns: a pointer to the allocated memory, cast to a pointer to @struct_type
2748 * SECTION:gdbusconnectio:
2749 * @short_description: D-Bus Connections
2750 * @include: gio/gio.h
2752 * The #GDBusConnection type is used for D-Bus connections to remote
2753 * peers such as a message buses. It is a low-level API that offers a
2754 * lot of flexibility. For instance, it lets you establish a connection
2755 * over any transport that can by represented as an #GIOStream.
2756 * This class is rarely used directly in D-Bus clients. If you are writing
2757 * an D-Bus client, it is often easier to use the g_bus_own_name(),
2758 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
2759 * <example id="gdbus-server"><title>D-Bus server example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-server.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
2760 * <example id="gdbus-subtree-server"><title>D-Bus subtree example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-subtree.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
2761 * <example id="gdbus-unix-fd-client"><title>D-Bus UNIX File Descriptor example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-unix-fd-client.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
2762 * <example id="gdbus-export"><title>Exporting a GObject</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-export.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
2767 * SECTION:gfileinputstrea:
2768 * @short_description: File input streaming operations
2769 * @include: gio/gio.h
2770 * @see_also: #GInputStream, #GDataInputStream, #GSeekable
2772 * GFileInputStream provides input streams that take their
2773 * content from a file.
2774 * GFileInputStream implements #GSeekable, which allows the input
2775 * stream to jump to arbitrary positions in the file, provided the
2776 * filesystem of the file allows it. To find the position of a file
2777 * input stream, use g_seekable_tell(). To find out if a file input
2778 * stream supports seeking, use g_seekable_stream_can_seek().
2779 * To position a file input stream, use g_seekable_seek().
2784 * g_socket_client_new:
2786 * Creates a new #GSocketClient with the default options.
2787 * Free the returned object with g_object_unref().
2789 * Returns: a #GSocketClient.
2795 * GDBusProxy:g-connection:
2797 * The #GDBusConnection the proxy is for.
2804 * g_file_enumerator_has_pending:
2805 * @enumerator: a #GFileEnumerator.
2807 * Checks if the file enumerator has pending operations.
2809 * Returns: %TRUE if the @enumerator has pending operations.
2815 * @socket: a #GSocket
2816 * @address: a #GSocketAddress, or %NULL
2817 * @buffer: (array length=size): the buffer containing the data to send.
2818 * @size: the number of bytes to send
2819 * @cancellable: (allow-none): a %GCancellable or %NULL
2820 * @error: #GError for error reporting, or %NULL to ignore.
2822 * Tries to send @size bytes from @buffer to @address. If @address is
2823 * %NULL then the message is sent to the default receiver (set by
2824 * g_socket_connect()).
2825 * See g_socket_send() for additional information.
2828 * Returns: Number of bytes written (which may be less than @size), or -1
2834 * g_file_new_for_uri:
2835 * @uri: a UTF8 string containing a URI.
2837 * Constructs a #GFile for a given URI. This operation never
2838 * fails, but the returned object might not support any I/O
2839 * operation if @uri is malformed or if the uri type is
2842 * Returns: (transfer full): a #GFile for the given @uri.
2847 * g_mount_operation_set_anonymous:
2848 * @op: a #GMountOperation.
2849 * @anonymous: boolean value.
2851 * Sets the mount operation to use an anonymous user if @anonymous is %TRUE.
2856 * G_TYPE_PARAM_OBJECT:
2858 * The #GType of #GParamSpecObject.
2864 * @title: GUnixFDMessage
2865 * @short_description: A GSocketControlMessage containing a GUnixFDList
2866 * @include: gio/gunixfdmessage.h
2867 * @see_also: #GUnixConnection, #GUnixFDList, #GSocketControlMessage
2869 * This #GSocketControlMessage contains a #GUnixFDList.
2870 * It may be sent using g_socket_send_message() and received using
2871 * %G_SOCKET_ADDRESS_UNIX family). The file descriptors are copied
2872 * between processes by the kernel.
2873 * For an easier way to send and receive file descriptors over
2874 * stream-oriented UNIX sockets, see g_unix_connection_send_fd() and
2875 * g_unix_connection_receive_fd().
2876 * Note that <filename><gio/gunixfdmessage.h></filename> belongs to
2877 * the UNIX-specific GIO interfaces, thus you have to use the
2878 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
2880 * G_socket_receive_message() over unix sockets (ie: sockets in the
2886 * @short_description: Drive management
2887 * @include: gio/gio.h
2889 * #GDrive - this represent a piece of hardware connected to the machine.
2890 * It's generally only created for removable hardware or hardware with
2892 * #GDrive is a container class for #GVolume objects that stem from
2893 * the same piece of media. As such, #GDrive abstracts a drive with
2894 * (or without) removable media and provides operations for querying
2895 * whether media is available, determing whether media change is
2896 * automatically detected and ejecting the media.
2897 * If the #GDrive reports that media isn't automatically detected, one
2898 * can poll for media; typically one should not do this periodically
2899 * as a poll for media operation is potententially expensive and may
2900 * spin up the drive creating noise.
2901 * #GDrive supports starting and stopping drives with authentication
2902 * support for the former. This can be used to support a diverse set
2903 * of use cases including connecting/disconnecting iSCSI devices,
2904 * powering down external disk enclosures and starting/stopping
2905 * multi-disk devices such as RAID devices. Note that the actual
2906 * semantics and side-effects of starting/stopping a #GDrive may vary
2907 * according to implementation. To choose the correct verbs in e.g. a
2908 * file manager, use g_drive_get_start_stop_type().
2909 * For porting from GnomeVFS note that there is no equivalent of
2910 * #GDrive in that API.
2915 * GTypePluginCompleteTypeInfo:
2916 * @plugin: the #GTypePlugin
2917 * @g_type: the #GType whose info is completed
2918 * @info: the #GTypeInfo struct to fill in
2919 * @value_table: the #GTypeValueTable to fill in
2921 * The type of the @complete_type_info function of #GTypePluginClass.
2926 * g_dbus_message_get_header_fields:
2927 * @message: A #GDBusMessage.
2929 * Gets an array of all header fields on @message that are set.
2930 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
2931 * #guchar. Free with g_free().
2933 * Returns: An array of header fields terminated by
2939 * g_application_get_application_id:
2940 * @application: a #GApplication
2941 * @returns: the identifier for @application, owned by @application
2943 * Gets the unique identifier for @application.
2950 * g_socket_connection_factory_create_connection:
2951 * @socket: a #GSocket
2953 * Creates a #GSocketConnection subclass of the right type for
2955 * Returns: (transfer full): a #GSocketConnection
2961 * g_drive_poll_for_media:
2962 * @drive: a #GDrive.
2963 * @cancellable: optional #GCancellable object, %NULL to ignore.
2964 * @callback: a #GAsyncReadyCallback, or %NULL.
2965 * @user_data: user data to pass to @callback
2967 * Asynchronously polls @drive to see if media has been inserted or removed.
2968 * When the operation is finished, @callback will be called.
2969 * You can then call g_drive_poll_for_media_finish() to obtain the
2970 * result of the operation.
2976 * @file: #GFile to send to trash.
2977 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2978 * @error: a #GError, or %NULL
2980 * Sends @file to the "Trashcan", if possible. This is similar to
2981 * deleting it, but the user can recover it before emptying the trashcan.
2982 * Not all file systems support trashing, so this call can return the
2983 * %G_IO_ERROR_NOT_SUPPORTED error.
2984 * If @cancellable is not %NULL, then the operation can be cancelled by
2985 * triggering the cancellable object from another thread. If the operation
2986 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2988 * Returns: %TRUE on successful trash, %FALSE otherwise.
2993 * g_unix_mounts_get:
2994 * @time_read: (allow-none): guint64 to contain a timestamp, or %NULL
2996 * Gets a #GList of #GUnixMountEntry containing the unix mounts.
2997 * If @time_read is set, it will be filled with the mount
2998 * timestamp, allowing for checking if the mounts have changed
2999 * with g_unix_mounts_changed_since().
3001 * Returns: (element-type utf8) (transfer full): a #GList of the UNIX mounts.
3007 * @short_description: Application information and launch contexts
3008 * @include: gio/gio.h
3010 * #GAppInfo and #GAppLaunchContext are used for describing and launching
3011 * applications installed on the system.
3012 * As of GLib 2.20, URIs will always be converted to POSIX paths
3013 * (using g_file_get_path()) when using g_app_info_launch() even if
3014 * the application requested an URI and not a POSIX path. For example
3015 * for an desktop-file based application with Exec key <literal>totem
3016 * %%U</literal> and a single URI,
3017 * <literal>sftp://foo/file.avi</literal>, then
3018 * <literal>/home/user/.gvfs/sftp on foo/file.avi</literal> will be
3019 * passed. This will only work if a set of suitable GIO extensions
3020 * (such as gvfs 2.26 compiled with FUSE support), is available and
3021 * operational; if this is not the case, the URI will be passed
3022 * unmodified to the application. Some URIs, such as
3023 * <literal>mailto:</literal>, of course cannot be mapped to a POSIX
3024 * path (in gvfs there's no FUSE mount for it); such URIs will be
3025 * passed unmodified to the application.
3026 * Specifically for gvfs 2.26 and later, the POSIX URI will be mapped
3027 * back to the GIO URI in the #GFile constructors (since gvfs
3028 * implements the #GVfs extension point). As such, if the application
3029 * needs to examine the URI, it needs to use g_file_get_uri() or
3030 * similar on #GFile. In other words, an application cannot assume
3031 * that the URI passed to e.g. g_file_new_for_commandline_arg() is
3032 * equal to the result of g_file_get_uri(). The following snippet
3037 * file = g_file_new_for_commandline_arg (uri_from_commandline);
3038 * uri = g_file_get_uri (file);
3039 * strcmp (uri, uri_from_commandline) == 0; // FALSE
3041 * if (g_file_has_uri_scheme (file, "cdda"))
3043 * // do something special with uri
3045 * g_object_unref (file);
3047 * This code will work when both <literal>cdda://sr0/Track
3048 * 1.wav</literal> and <literal>/home/user/.gvfs/cdda on sr0/Track
3049 * 1.wav</literal> is passed to the application. It should be noted
3050 * that it's generally not safe for applications to rely on the format
3051 * of a particular URIs. Different launcher applications (e.g. file
3052 * managers) may have different ideas of what a given URI means.
3059 * Use this for very low priority background tasks.
3060 * It is not used within GLib or GTK+.
3065 * g_proxy_address_get_destination_por:
3066 * @proxy: a #GProxyAddress
3068 * Gets @proxy's destination port.
3070 * Returns: the @proxy's destination port
3076 * g_action_group_get_action_state_type:
3077 * @action_group: a #GActionGroup
3078 * @action_name: the name of the action to query
3080 * Queries the type of the state of the named action within
3081 * If the action is stateful then this function returns the
3082 * #GVariantType of the state. All calls to g_action_group_set_state()
3083 * must give a #GVariant of this type and g_action_group_get_state()
3084 * will return a #GVariant of the same type.
3085 * If the action is not stateful then this function will return %NULL.
3086 * In that case, g_action_group_get_state() will return %NULL and you
3087 * must not call g_action_group_set_state().
3088 * The state type of a particular action will never change but it is
3089 * possible for an action to be removed and for a new action to be added
3090 * with the same name but a different state type.
3092 * Returns: (transfer full): the state type, if the action is stateful
3099 * @G_DRIVE_START_NONE: No flags set.
3101 * Flags used when starting a drive.
3108 * g_application_activate:
3109 * @application: a #GApplication
3111 * Activates the application.
3112 * In essence, this results in the #GApplication::activate() signal being
3113 * emitted in the primary instance.
3114 * The application must be registered before calling this function.
3121 * G_TYPE_PARAM_STRING:
3123 * The #GType of #GParamSpecString.
3128 * g_mount_unmount_with_operation:
3129 * @mount: a #GMount.
3130 * @flags: flags affecting the operation
3131 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
3132 * @cancellable: optional #GCancellable object, %NULL to ignore.
3133 * @callback: a #GAsyncReadyCallback, or %NULL.
3134 * @user_data: user data passed to @callback.
3136 * Unmounts a mount. This is an asynchronous operation, and is
3137 * finished by calling g_mount_unmount_with_operation_finish() with the @mount
3138 * and #GAsyncResult data returned in the @callback.
3145 * g_io_error_from_win32_error:
3146 * @error_code: Windows error number.
3148 * Converts some common error codes into GIO error codes. The
3149 * fallback value G_IO_ERROR_FAILED is returned for error codes not
3152 * Returns: #GIOErrorEnum value for the given error number.
3158 * g_file_stop_mountable_finish:
3159 * @file: input #GFile.
3160 * @result: a #GAsyncResult.
3161 * @error: a #GError, or %NULL
3163 * Finishes an stop operation, see g_file_stop_mountable() for details.
3164 * Finish an asynchronous stop operation that was started
3165 * with g_file_stop_mountable().
3168 * Returns: %TRUE if the operation finished successfully. %FALSE
3174 * g_cancellable_get_current:
3176 * Gets the top cancellable from the stack.
3177 * if the stack is empty.
3179 * Returns: (transfer none): a #GCancellable from the top of the stack, or %NULL
3184 * GSimpleAsyncResult:
3186 * A simple implementation of #GAsyncResult.
3191 * GTypeFundamentalInfo:
3192 * @type_flags: #GTypeFundamentalFlags describing the characteristics of the fundamental type
3194 * A structure that provides information to the type system which is
3195 * used specifically for managing fundamental types.
3200 * g_file_replace_readwrite_async:
3201 * @file: input #GFile.
3202 * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.
3203 * @make_backup: %TRUE if a backup should be created.
3204 * @flags: a set of #GFileCreateFlags.
3205 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
3206 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3207 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3208 * @user_data: (closure): the data to pass to callback function
3210 * Asynchronously overwrites the file in read-write mode, replacing the
3211 * contents, possibly creating a backup copy of the file first.
3212 * For more details, see g_file_replace_readwrite() which is
3213 * the synchronous version of this call.
3214 * When the operation is finished, @callback will be called. You can then
3215 * call g_file_replace_readwrite_finish() to get the result of the operation.
3222 * g_dbus_server_new_sync:
3223 * @address: A D-Bus address.
3224 * @flags: Flags from the #GDBusServerFlags enumeration.
3225 * @guid: A D-Bus GUID.
3226 * @observer: A #GDBusAuthObserver or %NULL.
3227 * @cancellable: A #GCancellable or %NULL.
3228 * @error: Return location for server or %NULL.
3230 * Creates a new D-Bus server that listens on the first address in
3231 * Once constructed, you can use g_dbus_server_get_client_address() to
3232 * get a D-Bus address string that clients can use to connect.
3233 * Connect to the #GDBusServer::new-connection signal to handle
3234 * incoming connections.
3235 * The returned #GDBusServer isn't active - you have to start it with
3236 * g_dbus_server_start().
3237 * See <xref linkend="gdbus-peer-to-peer"/> for how #GDBusServer can
3239 * This is a synchronous failable constructor. See
3240 * g_dbus_server_new() for the asynchronous version.
3243 * Returns: A #GDBusServer or %NULL if @error is set. Free with
3249 * g_settings_backend_flatten_tree:
3250 * @tree: a #GTree containing the changes
3251 * @path: the location to save the path
3252 * @keys: the location to save the relative keys
3253 * @values: the location to save the values, or %NULL
3255 * Calculate the longest common prefix of all keys in a tree and write
3256 * out an array of the key names relative to that prefix and,
3257 * optionally, the value to store at each of those keys.
3258 * You must free the value returned in @path, @keys and @values using
3259 * g_free(). You should not attempt to free or unref the contents of
3266 * g_poll_file_monitor_new:
3269 * Polls @file for changes.
3271 * Returns: a new #GFileMonitor for the given #GFile.
3276 * GInterfaceInitFunc:
3277 * @g_iface: The interface structure to initialize.
3278 * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure.
3280 * A callback function used by the type system to initialize a new
3281 * interface. This function should initialize all internal data and
3282 * allocate any resources required by the interface.
3287 * g_filter_output_stream_get_base_stream:
3288 * @stream: a #GFilterOutputStream.
3290 * Gets the base stream for the filter stream.
3292 * Returns: (transfer none): a #GOutputStream.
3297 * g_unix_mount_compare:
3298 * @mount1: first #GUnixMountEntry to compare.
3299 * @mount2: second #GUnixMountEntry to compare.
3301 * Compares two unix mounts.
3302 * or less than @mount2, respectively.
3304 * Returns: 1, 0 or -1 if @mount1 is greater than, equal to,
3309 * g_socket_client_get_tls:
3310 * @client: a #GSocketClient.
3312 * Gets whether @client creates TLS connections. See
3313 * g_socket_client_set_tls() for details.
3315 * Returns: whether @client uses TLS
3321 * g_action_group_get_action_parameter_type:
3322 * @action_group: a #GActionGroup
3323 * @action_name: the name of the action to query
3325 * Queries the type of the parameter that must be given when activating
3326 * the named action within @action_group.
3327 * When activating the action using g_action_group_activate(), the
3328 * #GVariant given to that function must be of the type returned by this
3330 * In the case that this function returns %NULL, you must not give any
3331 * #GVariant, but %NULL instead.
3332 * The parameter type of a particular action will never change but it is
3333 * possible for an action to be removed and for a new action to be added
3334 * with the same name but a different parameter type.
3336 * Returns: the parameter type
3342 * g_dbus_property_info_unref:
3343 * @info: A #GDBusPropertyInfo.
3345 * If @info is statically allocated, does nothing. Otherwise decreases
3346 * the reference count of @info. When its reference count drops to 0,
3347 * the memory used is freed.
3354 * G_VARIANT_TYPE_DICTIONARY:
3356 * An indefinite type that is a supertype of every dictionary type --
3357 * that is, any array type that has an element type equal to any
3358 * dictionary entry type.
3364 * @parent_instance: private #GParamSpec portion
3366 * A #GParamSpec derived structure that contains the meta data for object properties.
3371 * g_file_unmount_mountable_with_operation:
3372 * @file: input #GFile.
3373 * @flags: flags affecting the operation
3374 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
3375 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3376 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3377 * @user_data: (closure): the data to pass to callback function
3379 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
3380 * If @cancellable is not %NULL, then the operation can be cancelled by
3381 * triggering the cancellable object from another thread. If the operation
3382 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3383 * When the operation is finished, @callback will be called. You can then call
3384 * g_file_unmount_mountable_finish() to get the result of the operation.
3393 * The fundamental type from which all boxed types are derived.
3398 * GTlsCertificate:private-key:
3400 * The DER (binary) encoded representation of the certificate's
3401 * private key. This property (or the
3402 * #GTlsCertificate:private-key-pem property) can be set when
3403 * constructing a key (eg, from a file), but cannot be read.
3410 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED:
3412 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started
3414 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
3421 * g_permission_acquire_async:
3422 * @permission: a #GPermission instance
3423 * @cancellable: a #GCancellable, or %NULL
3424 * @callback: the #GAsyncReadyCallback to call when done
3425 * @user_data: the user data to pass to @callback
3427 * Attempts to acquire the permission represented by @permission.
3428 * This is the first half of the asynchronous version of
3429 * g_permission_acquire().
3436 * GSettingsBindGetMapping:
3437 * @value: return location for the property value
3438 * @variant: the #GVariant
3439 * @user_data: user data that was specified when the binding was created
3440 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
3442 * The type for the function that is used to convert from #GSettings to
3443 * an object property. The @value is already initialized to hold values
3444 * of the appropriate type.
3449 * SECTION:gdataoutputstrea:
3450 * @short_description: Data Output Stream
3451 * @include: gio/gio.h
3452 * @see_also: #GOutputStream
3454 * Data output stream implements #GOutputStream and includes functions for
3455 * writing data directly to an output stream.
3460 * g_output_stream_splice_async:
3461 * @stream: a #GOutputStream.
3462 * @source: a #GInputStream.
3463 * @flags: a set of #GOutputStreamSpliceFlags.
3464 * @io_priority: the io priority of the request.
3465 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3466 * @callback: (scope async): a #GAsyncReadyCallback.
3467 * @user_data: (closure): user data passed to @callback.
3469 * Splices a stream asynchronously.
3470 * When the operation is finished @callback will be called.
3471 * You can then call g_output_stream_splice_finish() to get the
3472 * result of the operation.
3473 * For the synchronous, blocking version of this function, see
3474 * g_output_stream_splice().
3480 * @other: a #GFileInfo.
3482 * Duplicates a file info structure.
3484 * Returns: (transfer full): a duplicate #GFileInfo of @other.
3489 * g_simple_action_group_lookup:
3490 * @simple: a #GSimpleActionGroup
3491 * @action_name: the name of an action
3493 * Looks up the action with the name @action_name in the group.
3494 * If no such action exists, returns %NULL.
3496 * Returns: (transfer none): a #GAction, or %NULL
3502 * g_output_stream_flush:
3503 * @stream: a #GOutputStream.
3504 * @cancellable: (allow-none): optional cancellable object
3505 * @error: location to store the error occuring, or %NULL to ignore
3507 * Flushed any outstanding buffers in the stream. Will block during
3508 * the operation. Closing the stream will implicitly cause a flush.
3509 * This function is optional for inherited classes.
3510 * If @cancellable is not %NULL, then the operation can be cancelled by
3511 * triggering the cancellable object from another thread. If the operation
3512 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3514 * Returns: %TRUE on success, %FALSE on error
3520 * @string: The string to check.
3522 * Checks if @string is a D-Bus GUID.
3523 * See the D-Bus specification regarding what strings are valid D-Bus
3524 * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
3526 * Returns: %TRUE if @string is a guid, %FALSE otherwise.
3532 * g_file_io_stream_get_etag:
3533 * @stream: a #GFileIOStream.
3535 * Gets the entity tag for the file when it has been written.
3536 * This must be called after the stream has been written
3537 * and closed, as the etag can change while writing.
3539 * Returns: the entity tag for the stream.
3545 * g_buffered_input_stream_read_byte:
3546 * @stream: a #GBufferedInputStream
3547 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
3548 * @error: location to store the error occuring, or %NULL to ignore
3550 * Tries to read a single byte from the stream or the buffer. Will block
3552 * On success, the byte read from the stream is returned. On end of stream
3553 * -1 is returned but it's not an exceptional error and @error is not set.
3554 * If @cancellable is not %NULL, then the operation can be cancelled by
3555 * triggering the cancellable object from another thread. If the operation
3556 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
3557 * operation was partially finished when the operation was cancelled the
3558 * partial result will be returned, without an error.
3559 * On error -1 is returned and @error is set accordingly.
3561 * Returns: the byte read from the @stream, or -1 on end of stream or error.
3566 * GSimpleActionGroup:
3568 * The #GSimpleActionGroup structure contains private data and should only be accessed using the provided API.
3575 * g_socket_set_blocking:
3576 * @socket: a #GSocket.
3577 * @blocking: Whether to use blocking I/O or not.
3579 * Sets the blocking mode of the socket. In blocking mode
3580 * all operations block until they succeed or there is an error. In
3581 * non-blocking mode all functions return results immediately or
3582 * with a %G_IO_ERROR_WOULD_BLOCK error.
3583 * All sockets are created in blocking mode. However, note that the
3584 * platform level socket is always non-blocking, and blocking mode
3585 * is a GSocket level feature.
3592 * g_buffered_input_stream_get_buffer_size:
3593 * @stream: a #GBufferedInputStream
3595 * Gets the size of the input buffer.
3597 * Returns: the current buffer size.
3602 * g_unix_fd_list_peek_fds:
3603 * @list: a #GUnixFDList
3604 * @length: (out) (allow-none): pointer to the length of the returned array, or %NULL
3606 * Returns the array of file descriptors that is contained in this
3608 * After this call, the descriptors remain the property of @list. The
3609 * caller must not close them and must not free the array. The array is
3610 * valid only until @list is changed in any way.
3611 * If @length is non-%NULL then it is set to the number of file
3612 * descriptors in the returned array. The returned array is also
3613 * terminated with -1.
3614 * This function never returns %NULL. In case there are no file
3615 * descriptors contained in @list, an empty array is returned.
3618 * Returns: (array length=length) (transfer none): an array of file
3624 * g_network_address_new:
3625 * @hostname: the hostname
3628 * Creates a new #GSocketConnectable for connecting to the given
3630 * Returns: (transfer full): the new #GNetworkAddress
3636 * g_file_info_has_namespace:
3637 * @info: a #GFileInfo.
3638 * @name_space: a file attribute namespace.
3640 * Checks if a file info structure has an attribute in the
3641 * specified @name_space.
3644 * Returns: %TRUE if @Ginfo has an attribute in @name_space,
3650 * g_data_output_stream_put_uint32:
3651 * @stream: a #GDataOutputStream.
3652 * @data: a #guint32.
3653 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3654 * @error: a #GError, %NULL to ignore.
3656 * Puts an unsigned 32-bit integer into the stream.
3658 * Returns: %TRUE if @data was successfully added to the @stream.
3663 * g_file_set_attribute:
3664 * @file: input #GFile.
3665 * @attribute: a string containing the attribute's name.
3666 * @type: The type of the attribute
3667 * @value_p: a pointer to the value (or the pointer itself if the type is a pointer type)
3668 * @flags: a set of #GFileQueryInfoFlags.
3669 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3670 * @error: a #GError, or %NULL
3672 * Sets an attribute in the file with attribute name @attribute to @value.
3673 * If @cancellable is not %NULL, then the operation can be cancelled by
3674 * triggering the cancellable object from another thread. If the operation
3675 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3677 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3682 * g_filename_completer_get_completion_suffix:
3683 * @completer: the filename completer.
3684 * @initial_text: text to be completed.
3686 * Obtains a completion for @initial_text from @completer.
3687 * This string is not owned by GIO, so remember to g_free() it
3690 * Returns: a completed string, or %NULL if no completion exists.
3695 * GFileMonitorFlags:
3696 * @G_FILE_MONITOR_NONE: No flags set.
3697 * @G_FILE_MONITOR_WATCH_MOUNTS: Watch for mount events.
3698 * @G_FILE_MONITOR_SEND_MOVED: Pair DELETED and CREATED events caused by file renames (moves) and send a single G_FILE_MONITOR_EVENT_MOVED event instead (NB: not supported on all backends; the default behaviour -without specifying this flag- is to send single DELETED and CREATED events).
3700 * Flags used to set what a #GFileMonitor will watch for.
3708 * Creates a new icon for a file.
3710 * Returns: (transfer full): a #GIcon for the given @file, or %NULL on error.
3715 * g_app_info_get_recommended_for_type:
3716 * @content_type: the content type to find a #GAppInfo for
3718 * Gets a list of recommended #GAppInfos for a given content type, i.e.
3719 * those applications which claim to support the given content type exactly,
3720 * and not by MIME type subclassing.
3721 * Note that the first application of the list is the last used one, i.e.
3722 * the last one for which #g_app_info_set_as_last_used_for_type has been
3724 * for given @content_type or %NULL on error.
3726 * Returns: (element-type GAppInfo) (transfer full): #GList of #GAppInfos
3732 * SECTION:gnetworkservic:
3733 * @short_description: A GSocketConnectable for resolving SRV records
3734 * @include: gio/gio.h
3736 * Like #GNetworkAddress does with hostnames, #GNetworkService
3737 * provides an easy way to resolve a SRV record, and then attempt to
3738 * connect to one of the hosts that implements that service, handling
3739 * service priority/weighting, multiple IP addresses, and multiple
3741 * See #GSrvTarget for more information about SRV records, and see
3742 * #GSocketConnectable for and example of using the connectable
3748 * g_file_start_mountable:
3749 * @file: input #GFile.
3750 * @flags: flags affecting the operation
3751 * @start_operation: a #GMountOperation, or %NULL to avoid user interaction.
3752 * @cancellable: optional #GCancellable object, %NULL to ignore.
3753 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3754 * @user_data: the data to pass to callback function
3756 * Starts a file of type G_FILE_TYPE_MOUNTABLE.
3757 * Using @start_operation, you can request callbacks when, for instance,
3758 * passwords are needed during authentication.
3759 * If @cancellable is not %NULL, then the operation can be cancelled by
3760 * triggering the cancellable object from another thread. If the operation
3761 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3762 * When the operation is finished, @callback will be called. You can then call
3763 * g_file_mount_mountable_finish() to get the result of the operation.
3770 * G_OBJECT_WARN_INVALID_PROPERTY_ID:
3771 * @object: the #GObject on which set_property() or get_property() was called
3772 * @property_id: the numeric id of the property
3773 * @pspec: the #GParamSpec of the property
3775 * This macro should be used to emit a standard warning about unexpected
3776 * properties in set_property() and get_property() implementations.
3781 * g_app_info_get_default_for_uri_scheme:
3782 * @uri_scheme: a string containing a URI scheme.
3784 * Gets the default application for launching applications
3785 * using this URI scheme. A URI scheme is the initial part
3786 * of the URI, up to but not including the ':', e.g. "http",
3789 * Returns: (transfer full): #GAppInfo for given @uri_scheme or %NULL on error.
3794 * g_file_set_attributes_finish:
3795 * @file: input #GFile.
3796 * @result: a #GAsyncResult.
3797 * @info: (out) (transfer full): a #GFileInfo.
3798 * @error: a #GError, or %NULL
3800 * Finishes setting an attribute started in g_file_set_attributes_async().
3802 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
3807 * G_VARIANT_TYPE_ARRAY:
3809 * An indefinite type that is a supertype of every array type.
3814 * g_socket_listener_accept:
3815 * @listener: a #GSocketListener
3816 * @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL
3817 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3818 * @error: #GError for error reporting, or %NULL to ignore.
3820 * Blocks waiting for a client to connect to any of the sockets added
3821 * to the listener. Returns a #GSocketConnection for the socket that was
3823 * If @source_object is not %NULL it will be filled out with the source
3824 * object specified when the corresponding socket or address was added
3826 * If @cancellable is not %NULL, then the operation can be cancelled by
3827 * triggering the cancellable object from another thread. If the operation
3828 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3830 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
3836 * g_dbus_node_info_unref:
3837 * @info: A #GDBusNodeInfo.
3839 * If @info is statically allocated, does nothing. Otherwise decreases
3840 * the reference count of @info. When its reference count drops to 0,
3841 * the memory used is freed.
3848 * g_unix_mount_point_guess_can_eject:
3849 * @mount_point: a #GUnixMountPoint
3851 * Guesses whether a Unix mount point can be ejected.
3853 * Returns: %TRUE if @mount_point is deemed to be ejectable.
3859 * @n_values: number of values contained in the array
3860 * @values: array of values
3862 * A #GValueArray contains an array of #GValue elements.
3867 * g_file_enumerate_children_finish:
3868 * @file: input #GFile.
3869 * @res: a #GAsyncResult.
3870 * @error: a #GError.
3872 * Finishes an async enumerate children operation.
3873 * See g_file_enumerate_children_async().
3874 * Free the returned object with g_object_unref().
3876 * Returns: (transfer full): a #GFileEnumerator or %NULL if an error occurred.
3881 * g_dbus_connection_flush:
3882 * @connection: A #GDBusConnection.
3883 * @cancellable: A #GCancellable or %NULL.
3884 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result.
3885 * @user_data: The data to pass to @callback.
3887 * Asynchronously flushes @connection, that is, writes all queued
3888 * outgoing message to the transport and then flushes the transport
3889 * (using g_output_stream_flush_async()). This is useful in programs
3890 * that wants to emit a D-Bus signal and then exit
3891 * immediately. Without flushing the connection, there is no guarantee
3892 * that the message has been sent to the networking buffers in the OS
3894 * This is an asynchronous method. When the operation is finished,
3895 * linkend="g-main-context-push-thread-default">thread-default main
3896 * loop</link> of the thread you are calling this method from. You can
3897 * then call g_dbus_connection_flush_finish() to get the result of the
3898 * operation. See g_dbus_connection_flush_sync() for the synchronous
3906 * g_inet_address_new_any:
3907 * @family: the address family
3909 * Creates a #GInetAddress for the "any" address (unassigned/"don't
3910 * care") for @family.
3913 * Returns: a new #GInetAddress corresponding to the "any" address
3921 * A #GInetSocketAddress representing a connection via a proxy server
3928 * g_emblemed_icon_get_emblems:
3929 * @emblemed: a #GEmblemedIcon
3931 * Gets the list of emblems for the @icon.
3932 * #GEmblem <!-- -->s that is owned by @emblemed
3934 * Returns: (element-type Gio.Emblem) (transfer none): a #GList of
3942 * The <structname>GMainLoop</structname> struct is an opaque data type
3943 * representing the main event loop of a GLib or GTK+ application.
3948 * g_file_io_stream_query_info_finish:
3949 * @stream: a #GFileIOStream.
3950 * @result: a #GAsyncResult.
3951 * @error: a #GError, %NULL to ignore.
3953 * Finalizes the asynchronous query started
3954 * by g_file_io_stream_query_info_async().
3956 * Returns: (transfer full): A #GFileInfo for the finished query.
3963 * @file: #gconstpointer to a #GFile.
3965 * Creates a hash value for a #GFile.
3966 * This call does no blocking i/o.
3967 * integer that can be used as hash value for the #GFile.
3968 * This function is intended for easily hashing a #GFile to
3969 * add to a #GHashTable or similar data structure.
3972 * Returns: 0 if @file is not a valid #GFile, otherwise an
3977 * g_inet_address_new_loopback:
3978 * @family: the address family
3980 * Creates a #GInetAddress for the loopback address for @family.
3983 * Returns: a new #GInetAddress corresponding to the loopback address
3989 * g_unix_mount_monitor_set_rate_limit:
3990 * @mount_monitor: a #GUnixMountMonitor
3991 * @limit_msec: a integer with the limit in milliseconds to poll for changes.
3993 * Sets the rate limit to which the @mount_monitor will report
3994 * consecutive change events to the mount and mount point entry files.
4002 * @source: input #GFile.
4003 * @destination: destination #GFile
4004 * @flags: set of #GFileCopyFlags
4005 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4006 * @progress_callback: (scope call): function to callback with progress information
4007 * @progress_callback_data: (closure): user data to pass to @progress_callback
4008 * @error: #GError to set on error, or %NULL
4010 * Copies the file @source to the location specified by @destination.
4011 * Can not handle recursive copies of directories.
4012 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
4013 * existing @destination file is overwritten.
4014 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
4015 * will be copied as symlinks, otherwise the target of the
4016 * If @cancellable is not %NULL, then the operation can be cancelled by
4017 * triggering the cancellable object from another thread. If the operation
4018 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4019 * If @progress_callback is not %NULL, then the operation can be monitored by
4020 * setting this to a #GFileProgressCallback function. @progress_callback_data
4021 * will be passed to this function. It is guaranteed that this callback will
4022 * be called after all data has been transferred with the total number of bytes
4023 * copied during the operation.
4024 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
4025 * error is returned, independent on the status of the @destination.
4026 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
4027 * error G_IO_ERROR_EXISTS is returned.
4028 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
4029 * error is returned. If trying to overwrite a directory with a directory the
4030 * G_IO_ERROR_WOULD_MERGE error is returned.
4031 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
4032 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
4034 * If you are interested in copying the #GFile object itself (not the on-disk
4035 * file), see g_file_dup().
4037 * Returns: %TRUE on success, %FALSE otherwise.
4042 * G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE:
4044 * A key in the "dos" namespace for checking if the file's archive flag
4045 * is set. This attribute is %TRUE if the archive flag is set. This attribute
4046 * is only available for DOS file systems. Corresponding #GFileAttributeType
4047 * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
4052 * g_file_set_attribute_int64:
4053 * @file: input #GFile.
4054 * @attribute: a string containing the attribute's name.
4055 * @value: a #guint64 containing the attribute's new value.
4056 * @flags: a #GFileQueryInfoFlags.
4057 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4058 * @error: a #GError, or %NULL
4060 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4061 * If @attribute is of a different type, this operation will fail.
4062 * If @cancellable is not %NULL, then the operation can be cancelled by
4063 * triggering the cancellable object from another thread. If the operation
4064 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4066 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4071 * G_FILE_ATTRIBUTE_STANDARD_TYPE:
4073 * A key in the "standard" namespace for storing file types.
4074 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
4075 * The value for this key should contain a #GFileType.
4080 * g_file_enumerator_next_files_finish:
4081 * @enumerator: a #GFileEnumerator.
4082 * @result: a #GAsyncResult.
4083 * @error: a #GError location to store the error occuring, or %NULL to ignore.
4085 * Finishes the asynchronous operation started with g_file_enumerator_next_files_async().
4086 * g_list_free() and unref the infos with g_object_unref() when you're
4089 * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with
4095 * @string: The string to check.
4097 * Checks if @string is a valid D-Bus bus name (either unique or well-known).
4099 * Returns: %TRUE if valid, %FALSE otherwise.
4105 * G_DEFINE_ABSTRACT_TYPE_WITH_CODE:
4106 * @TN: The name of the new type, in Camel case.
4107 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
4108 * @T_P: The #GType of the parent type.
4109 * @_C_: Custom code that gets inserted in the @type_name_get_type() function.
4111 * A convenience macro for type implementations.
4112 * Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and allows you to
4113 * insert custom code into the *_get_type() function, e.g. interface implementations
4114 * via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example.
4121 * g_tls_backend_supports_tls:
4122 * @backend: the #GTlsBackend
4124 * Checks if TLS is supported; if this returns %FALSE for the default
4125 * #GTlsBackend, it means no "real" TLS backend is available.
4127 * Returns: whether or not TLS is supported
4133 * g_unix_fd_message_new_with_fd_list:
4134 * @fd_list: a #GUnixFDList
4136 * Creates a new #GUnixFDMessage containing @list.
4138 * Returns: a new #GUnixFDMessage
4144 * GDBusConnection:flags:
4146 * Flags from the #GDBusConnectionFlags enumeration.
4153 * g_application_run:
4154 * @application: a #GApplication
4155 * @argc: the argc from main()
4156 * @argv: (array length=argc): the argv from main()
4157 * @returns: the exit status
4159 * Runs the application.
4160 * This function is intended to be run from main() and its return value
4161 * is intended to be returned by main().
4162 * First, the local_command_line() virtual function is invoked. This
4163 * function always runs on the local instance. If that function returns
4164 * %FALSE then the application is registered and the #GApplication::command-line
4165 * signal is emitted in the primary instance (which may or may not be
4167 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
4168 * flag set then the default implementation of local_command_line()
4169 * always returns %FALSE immediately, resulting in the commandline
4170 * always being handled in the primary instance.
4171 * Otherwise, the default implementation of local_command_line() tries
4172 * to do a couple of things that are probably reasonable for most
4173 * applications. First, g_application_register() is called to attempt
4174 * to register the application. If that works, then the command line
4175 * arguments are inspected. If no commandline arguments are given, then
4176 * g_application_activate() is called. If commandline arguments are
4177 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
4178 * are assumed to be filenames and g_application_open() is called.
4179 * If you are interested in doing more complicated local handling of the
4180 * commandline then you should implement your own #GApplication subclass
4181 * and override local_command_line(). See
4182 * <xref linkend="gapplication-example-cmdline2"/> for an example.
4183 * If, after the above is done, the use count of the application is zero
4184 * then the exit status is returned immediately. If the use count is
4185 * non-zero then the mainloop is run until the use count falls to zero,
4186 * at which point 0 is returned.
4187 * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
4188 * around to provide its <emphasis>service</emphasis> to others).
4190 * Use count of zero is delayed for a while (ie: the instance stays
4196 * g_socket_service_new:
4198 * Creates a new #GSocketService with no sockets to listen for.
4199 * New listeners can be added with e.g. g_socket_listener_add_address()
4200 * or g_socket_listener_add_inet_port().
4202 * Returns: a new #GSocketService.
4208 * G_VALUE_HOLDS_GTYPE:
4209 * @value: a valid #GValue structure
4211 * Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE.
4214 * Returns: %TRUE on success.
4219 * g_unix_connection_receive_fd:
4220 * @connection: a #GUnixConnection
4221 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
4222 * @error: (allow-none): #GError for error reporting, or %NULL to ignore
4224 * Receives a file descriptor from the sending end of the connection.
4225 * The sending end has to call g_unix_connection_send_fd() for this
4227 * As well as reading the fd this also reads a single byte from the
4228 * stream, as this is required for fd passing to work on some
4231 * Returns: a file descriptor on success, -1 on error.
4237 * GMountOperation::show-processes:
4238 * @op: a #GMountOperation.
4239 * @message: string containing a message to display to the user.
4240 * @processes: an array of #GPid for processes blocking the operation.
4241 * @choices: an array of strings for each possible choice.
4243 * Emitted when one or more processes are blocking an operation
4244 * e.g. unmounting/ejecting a #GMount or stopping a #GDrive.
4245 * Note that this signal may be emitted several times to update the
4246 * list of blocking processes as processes close files. The
4247 * application should only respond with g_mount_operation_reply() to
4248 * the latest signal (setting #GMountOperation:choice to the choice
4250 * If the message contains a line break, the first line should be
4251 * presented as a heading. For example, it may be used as the
4252 * primary text in a #GtkMessageDialog.
4260 * @class: a valid #GObjectClass
4262 * Casts a derived #GObjectClass structure into a #GObjectClass structure.
4267 * g_simple_async_result_set_error: (skip)
4268 * @simple: a #GSimpleAsyncResult.
4269 * @domain: a #GQuark (usually #G_IO_ERROR).
4270 * @code: an error code.
4271 * @format: a formatted error reporting string.
4272 * @...: a list of variables to fill in @format.
4274 * Sets an error within the asynchronous result without a #GError.
4280 * @G_BINDING_DEFAULT: The default binding; if the source property changes, the target property is updated with its value.
4281 * @G_BINDING_BIDIRECTIONAL: Bidirectional binding; if either the property of the source or the property of the target changes, the other is updated.
4282 * @G_BINDING_SYNC_CREATE: 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.
4283 * @G_BINDING_INVERT_BOOLEAN: 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().
4285 * Flags to be passed to g_object_bind_property() or
4286 * g_object_bind_property_full().
4287 * This enumeration can be extended at later date.
4294 * G_CLOSURE_N_NOTIFIERS:
4297 * Get the total number of notifiers connected with the closure @cl.
4298 * The count includes the meta marshaller, the finalize and invalidate notifiers
4299 * and the marshal guards. Note that each guard counts as two notifiers.
4300 * See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(),
4301 * g_closure_add_invalidate_notifier() and g_closure_add_marshal_guards().
4303 * Returns: number of notifiers
4308 * g_file_info_remove_attribute:
4309 * @info: a #GFileInfo.
4310 * @attribute: a file attribute key.
4312 * Removes all cases of @attribute from @info if it exists.
4317 * g_tcp_wrapper_connection_get_base_io_stream:
4318 * @conn: a #GTcpWrapperConnection
4320 * Get's @conn's base #GIOStream
4322 * Returns: (transfer none): @conn's base #GIOStream
4327 * G_IS_PARAM_SPEC_GTYPE:
4328 * @pspec: a #GParamSpec
4330 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_GTYPE.
4333 * Returns: %TRUE on success.
4338 * g_unix_input_stream_get_fd:
4339 * @stream: a #GUnixInputStream
4341 * Return the UNIX file descriptor that the stream reads from.
4343 * Returns: The file descriptor of @stream
4349 * g_dbus_connection_add_filter:
4350 * @connection: A #GDBusConnection.
4351 * @filter_function: A filter function.
4352 * @user_data: User data to pass to @filter_function.
4353 * @user_data_free_func: Function to free @user_data with when filter is removed or %NULL.
4355 * Adds a message filter. Filters are handlers that are run on all
4356 * incoming and outgoing messages, prior to standard dispatch. Filters
4357 * are run in the order that they were added. The same handler can be
4358 * added as a filter more than once, in which case it will be run more
4359 * than once. Filters added during a filter callback won't be run on
4360 * the message being processed. Filter functions are allowed to modify
4361 * and even drop messages - see the #GDBusMessageFilterResult
4362 * enumeration for details.
4363 * Note that filters are run in a dedicated message handling thread so
4364 * they can't block and, generally, can't do anything but signal a
4365 * worker thread. Also note that filters are rarely needed - use API
4366 * such as g_dbus_connection_send_message_with_reply(),
4367 * g_dbus_connection_signal_subscribe() or
4368 * g_dbus_connection_call() instead.
4369 * If a filter consumes an incoming message the message is not
4370 * dispatched anywhere else - not even the standard dispatch machinery
4371 * (that API such as g_dbus_connection_signal_subscribe() and
4372 * g_dbus_connection_send_message_with_reply() relies on) will see the
4373 * message. Similary, if a filter consumes an outgoing message, the
4374 * message will not be sent to the other peer.
4375 * g_dbus_connection_remove_filter().
4377 * Returns: A filter identifier that can be used with
4385 * Information about an installed application and methods to launch
4386 * it (with file arguments).
4391 * g_dbus_method_invocation_return_dbus_error:
4392 * @invocation: A #GDBusMethodInvocation.
4393 * @error_name: A valid D-Bus error name.
4394 * @error_message: A valid D-Bus error message.
4396 * Finishes handling a D-Bus method call by returning an error.
4397 * This method will free @invocation, you cannot use it afterwards.
4404 * g_file_info_get_attribute_string:
4405 * @info: a #GFileInfo.
4406 * @attribute: a file attribute key.
4408 * Gets the value of a string attribute. If the attribute does
4409 * not contain a string, %NULL will be returned.
4412 * Returns: the contents of the @attribute value as a string, or
4417 * g_content_type_equals:
4418 * @type1: a content type string
4419 * @type2: a content type string
4421 * Compares two content types for equality.
4424 * Returns: %TRUE if the two strings are identical or equivalent,
4429 * g_file_info_set_size:
4430 * @info: a #GFileInfo.
4431 * @size: a #goffset containing the file's size.
4433 * Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info
4434 * to the given size.
4439 * GApplication::startup:
4440 * @application: the application
4442 * The ::startup signal is emitted on the primary instance immediately
4443 * after registration. See g_activation_register().
4448 * GDBusConnectionFlags:
4449 * @G_DBUS_CONNECTION_FLAGS_NONE: No flags set.
4450 * @G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT: Perform authentication against server.
4451 * @G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER: Perform authentication against client.
4452 * @G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS: When authenticating as a server, allow the anonymous authentication method.
4453 * @G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION: Pass this flag if connecting to a peer that is a message bus. This means that the Hello() method will be invoked as part of the connection setup.
4454 * @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.
4456 * Flags used when creating a new #GDBusConnection.
4464 * @short_description: File Information and Attributes
4465 * @include: gio/gio.h
4466 * @see_also: #GFile, <link linkend="gio-GFileAttribute">GFileAttribute</link>
4468 * Functionality for manipulating basic metadata for files. #GFileInfo
4469 * implements methods for getting information that all files should
4470 * contain, and allows for manipulation of extended attributes.
4471 * See <link linkend="gio-GFileAttribute">GFileAttribute</link> for more
4472 * information on how GIO handles file attributes.
4473 * To obtain a #GFileInfo for a #GFile, use g_file_query_info() (or its
4474 * async variant). To obtain a #GFileInfo for a file input or output
4475 * stream, use g_file_input_stream_query_info() or
4476 * g_file_output_stream_query_info() (or their async variants).
4477 * To change the actual attributes of a file, you should then set the
4478 * attribute in the #GFileInfo and call g_file_set_attributes_from_info()
4479 * or g_file_set_attributes_async() on a GFile.
4480 * However, not all attributes can be changed in the file. For instance,
4481 * the actual size of a file cannot be changed via g_file_info_set_size().
4482 * You may call g_file_query_settable_attributes() and
4483 * g_file_query_writable_namespaces() to discover the settable attributes
4484 * of a particular file at runtime.
4485 * #GFileAttributeMatcher allows for searching through a #GFileInfo for
4492 * @socket: a #GSocket.
4493 * @address: a #GSocketAddress specifying the local address.
4494 * @allow_reuse: whether to allow reusing this address
4495 * @error: #GError for error reporting, or %NULL to ignore.
4497 * When a socket is created it is attached to an address family, but it
4498 * doesn't have an address in this family. g_socket_bind() assigns the
4499 * address (sometimes called name) of the socket.
4500 * It is generally required to bind to a local address before you can
4501 * receive connections. (See g_socket_listen() and g_socket_accept() ).
4502 * In certain situations, you may also want to bind a socket that will be
4503 * used to initiate connections, though this is not normally required.
4504 * eventually call g_socket_accept() on), and %FALSE for client sockets.
4505 * (Specifically, if it is %TRUE, then g_socket_bind() will set the
4506 * %SO_REUSEADDR flag on the socket, allowing it to bind @address even if
4507 * that address was previously used by another socket that has not yet been
4508 * fully cleaned-up by the kernel. Failing to set this flag on a server
4509 * socket may cause the bind call to return %G_IO_ERROR_ADDRESS_IN_USE if
4510 * the server program is stopped and then immediately restarted.)
4512 * Returns: %TRUE on success, %FALSE on error.
4518 * g_input_stream_read_all:
4519 * @stream: a #GInputStream.
4520 * @buffer: a buffer to read data into (which should be at least count bytes long).
4521 * @count: the number of bytes that will be read from the stream
4522 * @bytes_read: (out): location to store the number of bytes that was read from the stream
4523 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4524 * @error: location to store the error occuring, or %NULL to ignore
4526 * Tries to read @count bytes from the stream into the buffer starting at
4527 * This function is similar to g_input_stream_read(), except it tries to
4528 * read as many bytes as requested, only stopping on an error or end of stream.
4529 * On a successful read of @count bytes, or if we reached the end of the
4530 * stream, %TRUE is returned, and @bytes_read is set to the number of bytes
4531 * read into @buffer.
4532 * If there is an error during the operation %FALSE is returned and @error
4533 * is set to indicate the error status, @bytes_read is updated to contain
4534 * the number of bytes read into @buffer before the error occurred.
4536 * Returns: %TRUE on success, %FALSE if there was an error
4541 * G_VFS_EXTENSION_POINT_NAME:
4543 * Extension point for #GVfs functionality.
4544 * See <link linkend="extending-gio">Extending GIO</link>.
4549 * GParamSpecTypeInfo:
4550 * @instance_size: Size of the instance (object) structure.
4551 * @n_preallocs: 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 <link linkend="glib-Memory-Slices">slice allocator</link> now.
4552 * @instance_init: Location of the instance initialization function (optional).
4553 * @value_type: The #GType of values conforming to this #GParamSpec
4554 * @finalize: The instance finalization function (optional).
4555 * @value_set_default: Resets a @value to the default value for @pspec (recommended, the default is g_value_reset()), see g_param_value_set_default().
4556 * @value_validate: Ensures that the contents of @value comply with the specifications set out by @pspec (optional), see g_param_value_set_validate().
4557 * @values_cmp: Compares @value1 with @value2 according to @pspec (recommended, the default is memcmp()), see g_param_values_cmp().
4559 * This structure is used to provide the type system with the information
4560 * required to initialize and destruct (finalize) a parameter's class and
4561 * instances thereof.
4562 * The initialized structure is passed to the g_param_type_register_static()
4563 * The type system will perform a deep copy of this structure, so its memory
4564 * does not need to be persistent across invocation of
4565 * g_param_type_register_static().
4570 * G_TYPE_IS_VALUE_ABSTRACT:
4571 * @type: A #GType value.
4573 * Checks if @type is an abstract value type. An abstract value type introduces
4574 * a value table, but can't be used for g_value_init() and is normally used as
4575 * an abstract base type for derived value types.
4577 * Returns: %TRUE on success.
4582 * g_cancellable_pop_current:
4583 * @cancellable: a #GCancellable object
4585 * Pops @cancellable off the cancellable stack (verifying that @cancellable
4586 * is on the top of the stack).
4591 * SECTION:gthemedico:
4592 * @short_description: Icon theming support
4593 * @include: gio/gio.h
4594 * @see_also: #GIcon, #GLoadableIcon
4596 * #GThemedIcon is an implementation of #GIcon that supports icon themes.
4597 * #GThemedIcon contains a list of all of the icons present in an icon
4598 * theme, so that icons can be looked up quickly. #GThemedIcon does
4599 * not provide actual pixmaps for icons, just the icon names.
4600 * Ideally something like gtk_icon_theme_choose_icon() should be used to
4601 * resolve the list of names so that fallback icons work nicely with
4602 * themes that inherit other themes.
4607 * G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN:
4609 * A key in the "standard" namespace for checking if a file is hidden.
4610 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
4615 * GMountUnmountFlags:
4616 * @G_MOUNT_UNMOUNT_NONE: No flags set.
4617 * @G_MOUNT_UNMOUNT_FORCE: Unmount even if there are outstanding file operations on the mount.
4619 * Flags used when an unmounting a mount.
4624 * GAsyncInitableIface:
4625 * @g_iface: The parent interface.
4626 * @init_async: Starts initialization of the object.
4627 * @init_finish: Finishes initialization of the object.
4629 * Provides an interface for asynchronous initializing object such that
4630 * initialization may fail.
4637 * G_VALUE_HOLDS_UINT64:
4638 * @value: a valid #GValue structure
4640 * Checks whether the given #GValue can hold values of type %G_TYPE_UINT64.
4642 * Returns: %TRUE on success.
4647 * g_file_info_list_attributes:
4648 * @info: a #GFileInfo.
4649 * @name_space: a file attribute key's namespace.
4651 * Lists the file info structure's attributes.
4652 * possible attribute types for the given @name_space, or
4655 * Returns: (array zero-terminated=1) (transfer full): a null-terminated array of strings of all of the
4660 * GActionGroup::action-enabled-changed:
4661 * @action_group: the #GActionGroup that changed
4662 * @action_name: the name of the action in @action_group
4663 * @enabled: whether the action is enabled or not
4665 * Signals that the enabled status of the named action has changed.
4672 * g_dbus_connection_new_sync:
4673 * @stream: A #GIOStream.
4674 * @guid: The GUID to use if a authenticating as a server or %NULL.
4675 * @flags: Flags describing how to make the connection.
4676 * @observer: A #GDBusAuthObserver or %NULL.
4677 * @cancellable: A #GCancellable or %NULL.
4678 * @error: Return location for error or %NULL.
4680 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
4681 * with the end represented by @stream.
4682 * If @observer is not %NULL it may be used to control the
4683 * authentication process.
4684 * This is a synchronous failable constructor. See
4685 * g_dbus_connection_new() for the asynchronous version.
4687 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
4693 * GSocketListenerClass:
4694 * @changed: virtual method called when the set of socket listened to changes
4701 * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE:
4703 * A key in the "mountable" namespace for getting the unix device.
4704 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
4710 * @parent_class: the parent class
4711 * @load: loads the module and registers one or more types using g_type_module_register_type().
4712 * @unload: unloads the module
4714 * In order to implement dynamic loading of types based on #GTypeModule,
4715 * the @load and @unload functions in #GTypeModuleClass must be implemented.
4720 * SECTION:gbufferedinputstrea:
4721 * @short_description: Buffered Input Stream
4722 * @include: gio/gio.h
4723 * @see_also: #GFilterInputStream, #GInputStream
4725 * Buffered input stream implements #GFilterInputStream and provides
4726 * for buffered reads.
4727 * By default, #GBufferedInputStream's buffer size is set at 4 kilobytes.
4728 * To create a buffered input stream, use g_buffered_input_stream_new(),
4729 * or g_buffered_input_stream_new_sized() to specify the buffer's size at
4731 * To get the size of a buffer within a buffered input stream, use
4732 * g_buffered_input_stream_get_buffer_size(). To change the size of a
4733 * buffered input stream's buffer, use
4734 * g_buffered_input_stream_set_buffer_size(). Note that the buffer's size
4735 * cannot be reduced below the size of the data within the buffer.
4740 * g_proxy_connect_async:
4742 * @connection: a #GIOStream
4743 * @proxy_address: a #GProxyAddress
4744 * @cancellable: (allow-none): a #GCancellable
4745 * @callback: (scope async): a #GAsyncReadyCallback
4746 * @user_data: (closure): callback data
4748 * Asynchronous version of g_proxy_connect().
4755 * GSettings:delay-apply:
4757 * Whether the #GSettings object is in 'delay-apply' mode. See
4758 * g_settings_delay() for details.
4765 * g_resolver_lookup_service:
4766 * @resolver: a #GResolver
4767 * @service: the service type to look up (eg, "ldap")
4768 * @protocol: the networking protocol to use for @service (eg, "tcp")
4769 * @domain: the DNS domain to look up the service in
4770 * @cancellable: (allow-none): a #GCancellable, or %NULL
4771 * @error: return location for a #GError, or %NULL
4773 * Synchronously performs a DNS SRV lookup for the given @service and
4774 * include the leading underscore that appears in the actual DNS
4776 * On success, g_resolver_lookup_service() will return a #GList of
4777 * #GSrvTarget, sorted in order of preference. (That is, you should
4778 * attempt to connect to the first target first, then the second if
4779 * the first fails, etc.)
4780 * If the DNS resolution fails, @error (if non-%NULL) will be set to
4781 * a value from #GResolverError.
4782 * If @cancellable is non-%NULL, it can be used to cancel the
4783 * operation, in which case @error (if non-%NULL) will be set to
4784 * %G_IO_ERROR_CANCELLED.
4785 * If you are planning to connect to the service, it is usually easier
4786 * to create a #GNetworkService and use its #GSocketConnectable
4788 * or %NULL on error. You must free each of the targets and the list when you are
4789 * done with it. (You can use g_resolver_free_targets() to do this.)
4791 * Returns: (element-type GSrvTarget) (transfer full): a #GList of #GSrvTarget,
4798 * @file: input #GFile.
4799 * @flags: a set of #GFileCreateFlags.
4800 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4801 * @error: a #GError, or %NULL
4803 * Creates a new file and returns an output stream for writing to it.
4804 * The file must not already exist.
4805 * By default files created are generally readable by everyone,
4806 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
4807 * will be made readable only to the current user, to the level that
4808 * is supported on the target filesystem.
4809 * If @cancellable is not %NULL, then the operation can be cancelled by
4810 * triggering the cancellable object from another thread. If the operation
4811 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4812 * If a file or directory with this name already exists the G_IO_ERROR_EXISTS
4813 * error will be returned.
4814 * Some file systems don't allow all file names, and may
4815 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
4816 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
4817 * Other errors are possible too, and depend on what kind of
4818 * filesystem the file is on.
4820 * Free the returned object with g_object_unref().
4822 * Returns: (transfer full): a #GFileOutputStream for the newly created file, or
4827 * g_buffered_input_stream_fill:
4828 * @stream: a #GBufferedInputStream
4829 * @count: the number of bytes that will be read from the stream
4830 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
4831 * @error: location to store the error occuring, or %NULL to ignore
4833 * Tries to read @count bytes from the stream into the buffer.
4834 * Will block during this read.
4835 * If @count is zero, returns zero and does nothing. A value of @count
4836 * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
4837 * On success, the number of bytes read into the buffer is returned.
4838 * It is not an error if this is not the same as the requested size, as it
4839 * can happen e.g. near the end of a file. Zero is returned on end of file
4840 * (or if @count is zero), but never otherwise.
4841 * If @count is -1 then the attempted read size is equal to the number of
4842 * bytes that are required to fill the buffer.
4843 * If @cancellable is not %NULL, then the operation can be cancelled by
4844 * triggering the cancellable object from another thread. If the operation
4845 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
4846 * operation was partially finished when the operation was cancelled the
4847 * partial result will be returned, without an error.
4848 * On error -1 is returned and @error is set accordingly.
4849 * For the asynchronous, non-blocking, version of this function, see
4850 * g_buffered_input_stream_fill_async().
4853 * Returns: the number of bytes read into @stream's buffer, up to @count,
4858 * GDBusInterfaceVTable:
4859 * @method_call: Function for handling incoming method calls.
4860 * @get_property: Function for getting a property.
4861 * @set_property: Function for setting a property.
4863 * Virtual table for handling properties and method calls for a D-Bus
4865 * If you want to handle getting/setting D-Bus properties asynchronously, simply
4866 * register an object with the <literal>org.freedesktop.DBus.Properties</literal>
4867 * D-Bus interface using g_dbus_connection_register_object().
4874 * g_settings_backend_writable_changed:
4875 * @backend: a #GSettingsBackend implementation
4876 * @key: the name of the key
4878 * Signals that the writability of a single key has possibly changed.
4879 * Since GSettings performs no locking operations for itself, this call
4880 * will always be made in response to external events.
4888 * @connection: A #GDBusConnection.
4889 * @flags: Flags used when constructing the proxy.
4890 * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
4891 * @name: A bus name (well-known or unique) or %NULL if @connection is not a message bus connection.
4892 * @object_path: An object path.
4893 * @interface_name: A D-Bus interface name.
4894 * @cancellable: A #GCancellable or %NULL.
4895 * @callback: Callback function to invoke when the proxy is ready.
4896 * @user_data: User data to pass to @callback.
4898 * Creates a proxy for accessing @interface_name on the remote object
4899 * at @object_path owned by @name at @connection and asynchronously
4900 * loads D-Bus properties unless the
4901 * %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to
4902 * the #GDBusProxy::g-properties-changed signal to get notified about
4904 * If the %G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
4905 * match rules for signals. Connect to the #GDBusProxy::g-signal signal
4906 * to handle signals from the remote object.
4907 * If @name is a well-known name and the
4908 * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START flag isn't set and no name
4909 * owner currently exists, the message bus will be requested to launch
4910 * a name owner for the name.
4911 * This is a failable asynchronous constructor - when the proxy is
4912 * ready, @callback will be invoked and you can use
4913 * g_dbus_proxy_new_finish() to get the result.
4914 * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
4915 * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
4922 * g_unix_mount_point_free:
4923 * @mount_point: unix mount point to free.
4925 * Frees a unix mount point.
4930 * GInetSocketAddress:
4932 * An IPv4 or IPv6 socket address, corresponding to a <type>struct
4933 * sockaddr_in</type> or <type>struct sockaddr_in6</type>.
4938 * g_dbus_error_set_dbus_error_valist:
4939 * @error: A pointer to a #GError or %NULL.
4940 * @dbus_error_name: D-Bus error name.
4941 * @dbus_error_message: D-Bus error message.
4942 * @format: printf()-style format to prepend to @dbus_error_message or %NULL.
4943 * @var_args: Arguments for @format.
4945 * Like g_dbus_error_set_dbus_error() but intended for language bindings.
4952 * g_pollable_input_stream_can_poll:
4953 * @stream: a #GPollableInputStream.
4955 * Checks if @stream is actually pollable. Some classes may implement
4956 * #GPollableInputStream but have only certain instances of that class
4957 * be pollable. If this method returns %FALSE, then the behavior of
4958 * other #GPollableInputStream methods is undefined.
4959 * For any given stream, the value returned by this method is constant;
4960 * a stream cannot switch from pollable to non-pollable or vice versa.
4962 * Returns: %TRUE if @stream is pollable, %FALSE if not.
4969 * @G_DBUS_SIGNAL_FLAGS_NONE: No flags set.
4970 * @G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE: Don't actually send the AddMatch DBus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually).
4972 * Flags used when subscribing to signals via g_dbus_connection_signal_subscribe().
4980 * @drive: a #GDrive.
4981 * @flags: flags affecting the start operation.
4982 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
4983 * @cancellable: optional #GCancellable object, %NULL to ignore.
4984 * @callback: a #GAsyncReadyCallback, or %NULL.
4985 * @user_data: user data to pass to @callback
4987 * Asynchronously starts a drive.
4988 * When the operation is finished, @callback will be called.
4989 * You can then call g_drive_start_finish() to obtain the
4990 * result of the operation.
4997 * g_unix_credentials_message_new_with_credentials:
4998 * @credentials: A #GCredentials object.
5000 * Creates a new #GUnixCredentialsMessage holding @credentials.
5002 * Returns: a new #GUnixCredentialsMessage
5008 * g_file_create_readwrite:
5010 * @flags: a set of #GFileCreateFlags
5011 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
5012 * @error: return location for a #GError, or %NULL
5014 * Creates a new file and returns a stream for reading and writing to it.
5015 * The file must not already exist.
5016 * By default files created are generally readable by everyone,
5017 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
5018 * will be made readable only to the current user, to the level that
5019 * is supported on the target filesystem.
5020 * If @cancellable is not %NULL, then the operation can be cancelled by
5021 * triggering the cancellable object from another thread. If the operation
5022 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5023 * If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
5024 * error will be returned. Some file systems don't allow all file names,
5025 * and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
5026 * is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
5027 * are possible too, and depend on what kind of filesystem the file is on.
5028 * Note that in many non-local file cases read and write streams are not
5029 * supported, so make sure you really need to do read and write streaming,
5030 * rather than just opening for reading or writing.
5031 * Free the returned object with g_object_unref().
5033 * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error.
5039 * G_PARAM_SPEC_VALUE_ARRAY:
5040 * @pspec: a valid #GParamSpec instance
5042 * Cast a #GParamSpec instance into a #GParamSpecValueArray.
5047 * g_dbus_message_set_member:
5048 * @message: A #GDBusMessage.
5049 * @value: The value to set.
5051 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
5058 * g_socket_receive_from:
5059 * @socket: a #GSocket
5060 * @address: a pointer to a #GSocketAddress pointer, or %NULL
5061 * @buffer: a buffer to read data into (which should be at least @size bytes long).
5062 * @size: the number of bytes you want to read from the socket
5063 * @cancellable: (allow-none): a %GCancellable or %NULL
5064 * @error: #GError for error reporting, or %NULL to ignore.
5066 * Receive data (up to @size bytes) from a socket.
5067 * If @address is non-%NULL then @address will be set equal to the
5068 * source address of the received packet.
5069 * See g_socket_receive() for additional information.
5071 * Returns: Number of bytes read, or -1 on error
5077 * g_seekable_can_seek:
5078 * @seekable: a #GSeekable.
5080 * Tests if the stream supports the #GSeekableIface.
5082 * Returns: %TRUE if @seekable can be seeked. %FALSE otherwise.
5087 * GCredentialsClass:
5089 * Class structure for #GCredentials.
5096 * GDBusMessageFilterFunction:
5097 * @connection: (transfer none): A #GDBusConnection.
5098 * @message: (transfer full): A locked #GDBusMessage that the filter function takes ownership of.
5099 * @incoming: %TRUE if it is a message received from the other peer, %FALSE if it is a message to be sent to the other peer.
5100 * @user_data: User data passed when adding the filter.
5102 * Signature for function used in g_dbus_connection_add_filter().
5103 * A filter function is passed a #GDBusMessage and expected to return
5104 * a #GDBusMessage too. Passive filter functions that don't modify the
5105 * message can simply return the @message object:
5107 * static GDBusMessage *
5108 * passive_filter (GDBusConnection *connection
5109 * GDBusMessage *message,
5110 * gboolean incoming,
5111 * gpointer user_data)
5113 * /<!-- -->* inspect @message *<!-- -->/
5117 * Filter functions that wants to drop a message can simply return %NULL:
5119 * static GDBusMessage *
5120 * drop_filter (GDBusConnection *connection
5121 * GDBusMessage *message,
5122 * gboolean incoming,
5123 * gpointer user_data)
5125 * if (should_drop_message)
5127 * g_object_unref (message);
5133 * Finally, a filter function may modify a message by copying it:
5135 * static GDBusMessage *
5136 * modifying_filter (GDBusConnection *connection
5137 * GDBusMessage *message,
5138 * gboolean incoming,
5139 * gpointer user_data)
5141 * GDBusMessage *copy;
5144 * copy = g_dbus_message_copy (message, &error);
5145 * /<!-- -->* handle @error being is set *<!-- -->/
5146 * g_object_unref (message);
5147 * /<!-- -->* modify @copy *<!-- -->/
5151 * If the returned #GDBusMessage is different from @message and cannot
5152 * be sent on @connection (it could use features, such as file
5153 * descriptors, not compatible with @connection), then a warning is
5154 * logged to <emphasis>standard error</emphasis>. Applications can
5155 * check this ahead of time using g_dbus_message_to_blob() passing a
5156 * #GDBusCapabilityFlags value obtained from @connection.
5157 * g_object_unref() or %NULL to drop the message. Passive filter
5158 * functions can simply return the passed @message object.
5160 * Returns: (transfer full) (allow-none): A #GDBusMessage that will be freed with
5166 * g_unix_mount_get_fs_type:
5167 * @mount_entry: a #GUnixMount.
5169 * Gets the filesystem type for the unix mount.
5171 * Returns: a string containing the file system type.
5176 * g_file_attribute_matcher_new:
5177 * @attributes: an attribute string to match.
5179 * Creates a new file attribute matcher, which matches attributes
5180 * against a given string. #GFileAttributeMatcher<!-- -->s are reference
5181 * counted structures, and are created with a reference count of 1. If
5182 * the number of references falls to 0, the #GFileAttributeMatcher is
5183 * automatically destroyed.
5184 * The @attribute string should be formatted with specific keys separated
5185 * from namespaces with a double colon. Several "namespace::key" strings may be
5186 * concatenated with a single comma (e.g. "standard::type,standard::is-hidden").
5187 * The wildcard "*" may be used to match all keys and namespaces, or
5188 * "namespace::*" will match all keys in a given namespace.
5189 * Examples of strings to use:
5191 * <title>File Attribute Matcher strings and results</title>
5192 * <tgroup cols='2' align='left'><thead>
5193 * <row><entry> Matcher String </entry><entry> Matches </entry></row></thead>
5195 * <row><entry>"*"</entry><entry>matches all attributes.</entry></row>
5196 * <row><entry>"standard::is-hidden"</entry><entry>matches only the key is-hidden in the standard namespace.</entry></row>
5197 * <row><entry>"standard::type,unix::*"</entry><entry>matches the type key in the standard namespace and
5198 * all keys in the unix namespace.</entry></row>
5202 * Returns: a #GFileAttributeMatcher.
5207 * GDBusMethodInvocation:
5209 * The #GDBusMethodInvocation structure contains only private data and
5210 * should only be accessed using the provided API.
5217 * G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE:
5219 * A key in the "mountable" namespace for getting the #GDriveStartStopType.
5220 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
5229 * An IPv4 or IPv6 internet address.
5234 * g_tls_connection_set_require_close_notify:
5235 * @conn: a #GTlsConnection
5236 * @require_close_notify: whether or not to require close notification
5238 * Sets whether or not @conn expects a proper TLS close notification
5239 * before the connection is closed. If this is %TRUE (the default),
5240 * then @conn will expect to receive a TLS close notification from its
5241 * peer before the connection is closed, and will return a
5242 * %G_TLS_ERROR_EOF error if the connection is closed without proper
5243 * notification (since this may indicate a network error, or
5244 * man-in-the-middle attack).
5245 * In some protocols, the application will know whether or not the
5246 * connection was closed cleanly based on application-level data
5247 * (because the application-level data includes a length field, or is
5248 * somehow self-delimiting); in this case, the close notify is
5249 * redundant and sometimes omitted. (TLS 1.1 explicitly allows this;
5250 * in TLS 1.0 it is technically an error, but often done anyway.) You
5251 * can use g_tls_connection_set_require_close_notify() to tell @conn
5252 * to allow an "unannounced" connection close, in which case the close
5253 * will show up as a 0-length read, as in a non-TLS
5254 * #GSocketConnection, and it is up to the application to check that
5255 * the data has been fully received.
5256 * Note that this only affects the behavior when the peer closes the
5257 * connection; when the application calls g_io_stream_close() itself
5258 * on @conn, this will send a close notification regardless of the
5259 * setting of this property. If you explicitly want to do an unclean
5260 * close, you can close @conn's #GTlsConnection:base-io-stream rather
5261 * than closing @conn itself.
5268 * g_pollable_input_stream_is_readable:
5269 * @stream: a #GPollableInputStream.
5271 * Checks if @stream can be read.
5272 * Note that some stream types may not be able to implement this 100%
5273 * reliably, and it is possible that a call to g_input_stream_read()
5274 * after this returns %TRUE would still block. To guarantee
5275 * non-blocking behavior, you should always use
5276 * g_pollable_input_stream_read_nonblocking(), which will return a
5277 * %G_IO_ERROR_WOULD_BLOCK error rather than blocking.
5278 * has occurred on @stream, this will result in
5279 * g_pollable_input_stream_is_readable() returning %TRUE, and the
5280 * next attempt to read will return the error.
5282 * Returns: %TRUE if @stream is readable, %FALSE if not. If an error
5288 * GDBusPropertyInfoFlags:
5289 * @G_DBUS_PROPERTY_INFO_FLAGS_NONE: No flags set.
5290 * @G_DBUS_PROPERTY_INFO_FLAGS_READABLE: Property is readable.
5291 * @G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE: Property is writable.
5293 * Flags describing the access control of a D-Bus property.
5300 * g_node_next_sibling:
5303 * Gets the next sibling of a #GNode.
5306 * Returns: the next sibling of @node, or %NULL if @node is the last node
5311 * GTlsServerConnection:
5313 * TLS server-side connection. This is the server-side implementation
5314 * of a #GTlsConnection.
5321 * G_PARAM_SPEC_ENUM:
5322 * @pspec: a valid #GParamSpec instance
5324 * Cast a #GParamSpec instance into a #GParamSpecEnum.
5329 * g_file_info_get_attribute_type:
5330 * @info: a #GFileInfo.
5331 * @attribute: a file attribute key.
5333 * Gets the attribute type for an attribute key.
5334 * %G_FILE_ATTRIBUTE_TYPE_INVALID if the key is not set.
5336 * Returns: a #GFileAttributeType for the given @attribute, or
5341 * g_inet_socket_address_get_port:
5342 * @address: a #GInetSocketAddress
5344 * Gets @address's port.
5346 * Returns: the port for @address
5352 * g_dbus_message_get_destination:
5353 * @message: A #GDBusMessage.
5355 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
5357 * Returns: The value.
5365 * A value representing an interval of time, in microseconds.
5373 * @ref_count: The reference count or -1 if statically allocated.
5374 * @path: The path of the node or %NULL if omitted. Note that this may be a relative path. See the D-Bus specification for more details.
5375 * @interfaces: A pointer to a %NULL-terminated array of pointers to #GDBusInterfaceInfo structures or %NULL if there are no interfaces.
5376 * @nodes: A pointer to a %NULL-terminated array of pointers to #GDBusNodeInfo structures or %NULL if there are no nodes.
5377 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
5379 * Information about nodes in a remote object hierarchy.
5387 * @type: Type id to check
5389 * Check if the passed in type id is a %G_TYPE_OBJECT or derived from it.
5391 * Returns: %FALSE or %TRUE, indicating whether @type is a %G_TYPE_OBJECT.
5396 * g_settings_list_schemas:
5398 * Gets a list of the #GSettings schemas installed on the system. The
5399 * returned list is exactly the list of schemas for which you may call
5400 * g_settings_new() without adverse effects.
5401 * This function does not list the schemas that do not provide their own
5402 * g_settings_new_with_path()). See
5403 * g_settings_list_relocatable_schemas() for that.
5404 * schemas that are available. The list must not be modified or
5407 * Paths (ie: schemas for which you must use
5408 * Returns: (element-type utf8) (transfer none): a list of #GSettings
5414 * g_file_load_contents:
5415 * @file: input #GFile.
5416 * @cancellable: optional #GCancellable object, %NULL to ignore.
5417 * @contents: (out) (transfer full): a location to place the contents of the file.
5418 * @length: (out) (allow-none): a location to place the length of the contents of the file, or %NULL if the length is not needed
5419 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file, or %NULL if the entity tag is not needed
5420 * @error: a #GError, or %NULL
5422 * Loads the content of the file into memory. The data is always
5423 * zero-terminated, but this is not included in the resultant @length.
5424 * The returned @content should be freed with g_free() when no longer
5426 * If @cancellable is not %NULL, then the operation can be cancelled by
5427 * triggering the cancellable object from another thread. If the operation
5428 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5429 * %FALSE if there were errors.
5431 * Returns: %TRUE if the @file's contents were successfully loaded.
5436 * g_inet_address_get_is_multicast:
5437 * @address: a #GInetAddress
5439 * Tests whether @address is a multicast address.
5441 * Returns: %TRUE if @address is a multicast address.
5447 * GDBusServer:flags:
5449 * Flags from the #GDBusServerFlags enumeration.
5456 * GConverterOutputStream:
5458 * An implementation of #GFilterOutputStream that allows data
5466 * The name of the schema that describes the types of keys
5467 * for this #GSettings object.
5472 * G_TYPE_IS_VALUE_TYPE:
5473 * @type: A #GType value.
5475 * Checks if @type is a value type and can be used with g_value_init().
5477 * Returns: %TRUE on success.
5482 * g_volume_monitor_get_volume_for_uuid:
5483 * @volume_monitor: a #GVolumeMonitor.
5484 * @uuid: the UUID to look for
5486 * Finds a #GVolume object by its UUID (see g_volume_get_uuid())
5487 * Free the returned object with g_object_unref().
5489 * Returns: (transfer full): a #GVolume or %NULL if no such volume is available.
5494 * G_SIGNAL_FLAGS_MASK:
5496 * A mask for all #GSignalFlags bits.
5501 * G_TYPE_DBUS_INTERFACE_INFO:
5503 * The #GType for a boxed type holding a #GDBusInterfaceInfo.
5510 * g_settings_set_enum:
5511 * @settings: a #GSettings object
5512 * @key: a key, within @settings
5513 * @value: an enumerated value
5514 * @returns: %TRUE, if the set succeeds
5516 * Looks up the enumerated type nick for @value and writes it to @key,
5518 * It is a programmer error to give a @key that isn't contained in the
5519 * schema for @settings or is not marked as an enumerated type, or for
5520 * After performing the write, accessing @key directly with
5521 * g_settings_get_string() will return the 'nick' associated with
5526 * g_network_address_parse:
5527 * @host_and_port: the hostname and optionally a port
5528 * @default_port: the default port if not in @host_and_port
5529 * @error: a pointer to a #GError, or %NULL
5531 * Creates a new #GSocketConnectable for connecting to the given
5532 * parsing @host_and_port fails.
5533 * address, an IPv4 address, or a domain name (in which case a DNS
5534 * lookup is performed). Quoting with [] is supported for all address
5535 * types. A port override may be specified in the usual way with a
5536 * colon. Ports may be given as decimal numbers or symbolic names (in
5537 * which case an /etc/services lookup is performed).
5538 * If no port is specified in @host_and_port then @default_port will be
5539 * used as the port number to connect to.
5540 * In general, @host_and_port is expected to be provided by the user
5541 * (allowing them to give the hostname, and a port overide if necessary)
5542 * and @default_port is expected to be provided by the application.
5544 * Returns: (transfer full): the new #GNetworkAddress, or %NULL on error
5551 * @struct_type: Type of memory chunks to be allocated
5552 * @n_structs: Number of chunks to be allocated
5554 * Wraps g_alloca() in a more typesafe manner.
5556 * Returns: Pointer to stack space for @n_structs chunks of type @struct_type
5561 * G_IMPLEMENT_INTERFACE_DYNAMIC:
5562 * @TYPE_IFACE: The #GType of the interface to add
5563 * @iface_init: The interface init function
5565 * A convenience macro to ease interface addition in the @_C_ section
5566 * of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See G_DEFINE_DYNAMIC_TYPE_EXTENDED()
5568 * Note that this macro can only be used together with the
5569 * G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable
5570 * names from that macro.
5577 * g_settings_backend_path_changed:
5578 * @backend: a #GSettingsBackend implementation
5579 * @path: the path containing the changes
5580 * @origin_tag: the origin tag
5582 * Signals that all keys below a given path may have possibly changed.
5583 * Backend implementations should call this if an entire path of keys
5584 * have possibly changed their values.
5585 * not containing '//').
5586 * The meaning of this signal is that any of the key which has a name
5587 * starting with @path may have changed.
5588 * The same rules for when notifications must occur apply as per
5589 * g_settings_backend_changed(). This call might be an appropriate
5590 * reasponse to a 'reset' call but implementations are also free to
5591 * explicitly list the keys that were affected by that call if they can
5593 * For efficiency reasons, the implementation should strive for @path to
5594 * keys that were changed) but this is not strictly required. As an
5595 * example, if this function is called with the path of "/" then every
5596 * single key in the application will be notified of a possible change.
5598 * Be as long as possible (ie: the longest common prefix of all of the
5604 * g_socket_listener_accept_socket:
5605 * @listener: a #GSocketListener
5606 * @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL.
5607 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
5608 * @error: #GError for error reporting, or %NULL to ignore.
5610 * Blocks waiting for a client to connect to any of the sockets added
5611 * to the listener. Returns the #GSocket that was accepted.
5612 * If you want to accept the high-level #GSocketConnection, not a #GSocket,
5613 * which is often the case, then you should use g_socket_listener_accept()
5615 * If @source_object is not %NULL it will be filled out with the source
5616 * object specified when the corresponding socket or address was added
5618 * If @cancellable is not %NULL, then the operation can be cancelled by
5619 * triggering the cancellable object from another thread. If the operation
5620 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5622 * Returns: (transfer full): a #GSocket on success, %NULL on error.
5628 * GVolumeMonitor::mount-removed:
5629 * @volume_monitor: The volume monitor emitting the signal.
5630 * @mount: a #GMount that was removed.
5632 * Emitted when a mount is removed.
5637 * g_socket_address_get_family:
5638 * @address: a #GSocketAddress
5640 * Gets the socket family type of @address.
5642 * Returns: the socket family type of @address.
5648 * G_DEFINE_BOXED_TYPE_WITH_CODE:
5649 * @TypeName: The name of the new type, in Camel case.
5650 * @type_name: The name of the new type, in lowercase, with words separated by '_'.
5651 * @copy_func: the #GBoxedCopyFunc for the new type
5652 * @free_func: the #GBoxedFreeFunc for the new type
5653 * @_C_: Custom code that gets inserted in the *_get_type() function.
5655 * A convenience macro for boxed type implementations.
5656 * Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the
5657 * type_name_get_type() function, e.g. to register value transformations with
5658 * g_value_register_transform_func().
5666 * @mount_path: path for a possible unix mount.
5667 * @time_read: guint64 to contain a timestamp.
5669 * Gets a #GUnixMountEntry for a given mount path. If @time_read
5670 * is set, it will be filled with a unix timestamp for checking
5671 * if the mounts have changed since with g_unix_mounts_changed_since().
5673 * Returns: (transfer full): a #GUnixMount.
5678 * g_simple_async_result_get_op_res_gssize:
5679 * @simple: a #GSimpleAsyncResult.
5681 * Gets a gssize from the asynchronous result.
5683 * Returns: a gssize returned from the asynchronous function.
5688 * G_TYPE_DBUS_NODE_INFO:
5690 * The #GType for a boxed type holding a #GDBusNodeInfo.
5697 * g_vfs_get_default:
5699 * Gets the default #GVfs for the system.
5701 * Returns: (transfer none): a #GVfs.
5706 * g_simple_action_new_stateful:
5707 * @name: the name of the action
5708 * @parameter_type: (allow-none): the type of the parameter to the activate function
5709 * @state: the initial state of the action
5711 * Creates a new stateful action.
5712 * must have the same #GVariantType as the initial state.
5713 * If the @state GVariant is floating, it is consumed.
5715 * Returns: a new #GSimpleAction
5721 * g_file_mount_mountable_finish:
5722 * @file: input #GFile.
5723 * @result: a #GAsyncResult.
5724 * @error: a #GError, or %NULL
5726 * Finishes a mount operation. See g_file_mount_mountable() for details.
5727 * Finish an asynchronous mount operation that was started
5728 * with g_file_mount_mountable().
5729 * Free the returned object with g_object_unref().
5731 * Returns: (transfer full): a #GFile or %NULL on error.
5737 * @pspec: a valid #GParamSpec
5739 * Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into
5740 * a #GParamSpec object.
5745 * g_drive_poll_for_media_finish:
5746 * @drive: a #GDrive.
5747 * @result: a #GAsyncResult.
5748 * @error: a #GError, or %NULL
5750 * Finishes an operation started with g_drive_poll_for_media() on a drive.
5753 * Returns: %TRUE if the drive has been poll_for_mediaed successfully,
5758 * G_TYPE_PARAM_UNICHAR:
5760 * The #GType of #GParamSpecUnichar.
5765 * g_dbus_message_set_reply_serial:
5766 * @message: A #GDBusMessage.
5767 * @value: The value to set.
5769 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
5777 * @name: the parameter name
5778 * @value: the parameter value
5780 * The <structname>GParameter</structname> struct is an auxiliary structure used
5781 * to hand parameter name/value pairs to g_object_newv().
5786 * SECTION:gdbusmethodinvocatio:
5787 * @short_description: Object for handling remote calls
5788 * @include: gio/gio.h
5790 * Instances of the #GDBusMethodInvocation class are used when
5791 * handling D-Bus method calls. It provides a way to asynchronously
5792 * return results and errors.
5793 * The normal way to obtain a #GDBusMethodInvocation object is to receive
5794 * it as an argument to the handle_method_call() function in a
5795 * #GDBusInterfaceVTable that was passed to g_dbus_connection_register_object().
5800 * g_async_initable_new_async:
5801 * @object_type: a #GType supporting #GAsyncInitable.
5802 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the operation.
5803 * @cancellable: optional #GCancellable object, %NULL to ignore.
5804 * @callback: a #GAsyncReadyCallback to call when the initialization is finished
5805 * @user_data: the data to pass to callback function
5806 * @first_property_name: the name of the first property, or %NULL if no properties
5807 * @...: the value of the first property, followed by other property value pairs, and ended by %NULL.
5809 * Helper function for constructing #GAsyncInitiable object. This is
5810 * similar to g_object_new() but also initializes the object asynchronously.
5811 * When the initialization is finished, @callback will be called. You can
5812 * then call g_async_initable_new_finish() to get the new object and check
5820 * GFilterOutputStream:
5822 * A base class for all output streams that work on an underlying stream.
5827 * G_FILE_ATTRIBUTE_TIME_CHANGED_USEC:
5829 * A key in the "time" namespace for getting the microseconds of the time
5830 * the file was last changed. This should be used in conjunction with
5831 * #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is
5832 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
5837 * GWin32OutputStream:handle:
5839 * The file handle that the stream writes to.
5846 * SECTION:gasyncresul:
5847 * @short_description: Asynchronous Function Results
5848 * @include: gio/gio.h
5849 * @see_also: #GSimpleAsyncResult
5851 * Provides a base class for implementing asynchronous function results.
5852 * Asynchronous operations are broken up into two separate operations
5853 * which are chained together by a #GAsyncReadyCallback. To begin
5854 * an asynchronous operation, provide a #GAsyncReadyCallback to the
5855 * asynchronous function. This callback will be triggered when the
5856 * operation has completed, and will be passed a #GAsyncResult instance
5857 * filled with the details of the operation's success or failure, the
5858 * object the asynchronous function was started for and any error codes
5859 * returned. The asynchronous callback function is then expected to call
5860 * the corresponding "_finish()" function, passing the object the
5861 * function was called for, the #GAsyncResult instance, and (optionally)
5862 * an @error to grab any error conditions that may have occurred.
5863 * The "_finish()" function for an operation takes the generic result
5864 * (of type #GAsyncResult) and returns the specific result that the
5865 * operation in question yields (e.g. a #GFileEnumerator for a
5866 * "enumerate children" operation). If the result or error status of the
5867 * operation is not needed, there is no need to call the "_finish()"
5868 * function; GIO will take care of cleaning up the result and error
5869 * information after the #GAsyncReadyCallback returns. Applications may
5870 * also take a reference to the #GAsyncResult and call "_finish()"
5871 * later; however, the "_finish()" function may be called at most once.
5872 * Example of a typical asynchronous operation flow:
5874 * void _theoretical_frobnitz_async (Theoretical *t,
5876 * GAsyncReadyCallback *cb,
5878 * gboolean _theoretical_frobnitz_finish (Theoretical *t,
5879 * GAsyncResult *res,
5882 * frobnitz_result_func (GObject *source_object,
5883 * GAsyncResult *res,
5884 * gpointer user_data)
5886 * gboolean success = FALSE;
5887 * success = _theoretical_frobnitz_finish (source_object, res, NULL);
5889 * g_printf ("Hurray!\n");
5891 * g_printf ("Uh oh!\n");
5892 * /<!-- -->* ... *<!-- -->/
5894 * int main (int argc, void *argv[])
5896 * /<!-- -->* ... *<!-- -->/
5897 * _theoretical_frobnitz_async (theoretical_data,
5899 * frobnitz_result_func,
5901 * /<!-- -->* ... *<!-- -->/
5904 * The callback for an asynchronous operation is called only once, and is
5905 * always called, even in the case of a cancelled operation. On cancellation
5906 * the result is a %G_IO_ERROR_CANCELLED error.
5907 * Some asynchronous operations are implemented using synchronous calls.
5908 * These are run in a separate thread, if #GThread has been initialized, but
5909 * otherwise they are sent to the Main Event Loop and processed in an idle
5910 * function. So, if you truly need asynchronous operations, make sure to
5911 * initialize #GThread.
5916 * g_icon_new_for_string:
5917 * @str: A string obtained via g_icon_to_string().
5918 * @error: Return location for error.
5920 * Generate a #GIcon instance from @str. This function can fail if
5921 * If your application or library provides one or more #GIcon
5922 * implementations you need to ensure that each #GType is registered
5923 * with the type system prior to calling g_icon_new_for_string().
5924 * interface or %NULL if @error is set.
5926 * Returns: (transfer full): An object implementing the #GIcon
5932 * g_app_info_supports_files:
5933 * @appinfo: a #GAppInfo.
5935 * Checks if the application accepts files as arguments.
5937 * Returns: %TRUE if the @appinfo supports files.
5942 * g_action_group_get_action_state:
5943 * @action_group: a #GActionGroup
5944 * @action_name: the name of the action to query
5946 * Queries the current state of the named action within @action_group.
5947 * If the action is not stateful then %NULL will be returned. If the
5948 * action is stateful then the type of the return value is the type
5949 * given by g_action_group_get_state_type().
5950 * The return value (if non-%NULL) should be freed with
5951 * g_variant_unref() when it is no longer required.
5953 * Returns: (allow-none): the current state of the action
5960 * @drive: a #GDrive.
5962 * Checks if a drive can be stopped.
5964 * Returns: %TRUE if the @drive can be stopped, %FALSE otherwise.
5970 * g_file_input_stream_query_info_async:
5971 * @stream: a #GFileInputStream.
5972 * @attributes: a file attribute query string.
5973 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
5974 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
5975 * @callback: (scope async): callback to call when the request is satisfied
5976 * @user_data: (closure): the data to pass to callback function
5978 * Queries the stream information asynchronously.
5979 * When the operation is finished @callback will be called.
5980 * You can then call g_file_input_stream_query_info_finish()
5981 * to get the result of the operation.
5982 * For the synchronous version of this function,
5983 * see g_file_input_stream_query_info().
5984 * If @cancellable is not %NULL, then the operation can be cancelled by
5985 * triggering the cancellable object from another thread. If the operation
5986 * was cancelled, the error %G_IO_ERROR_CANCELLED will be set
5991 * GSimplePermission:
5993 * #GSimplePermission is an opaque data structure. There are no methods
5994 * except for those defined by #GPermission.
5999 * G_TYPE_RESERVED_GLIB_LAST:
6001 * Last fundamental type number reserved for GLib.
6006 * g_data_input_stream_read_until:
6007 * @stream: a given #GDataInputStream.
6008 * @stop_chars: characters to terminate the read.
6009 * @length: (out): a #gsize to get the length of the data read in.
6010 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6011 * @error: #GError for error reporting.
6013 * Reads a string from the data input stream, up to the first
6014 * occurrence of any of the stop characters.
6015 * Note that, in contrast to g_data_input_stream_read_until_async(),
6016 * this function consumes the stop character that it finds.
6017 * Don't use this function in new code. Its functionality is
6018 * inconsistent with g_data_input_stream_read_until_async(). Both
6019 * functions will be marked as deprecated in a future release. Use
6020 * g_data_input_stream_read_upto() instead, but note that that function
6021 * does not consume the stop character.
6022 * before encountering any of the stop characters. Set @length to
6023 * a #gsize to get the length of the string. This function will
6024 * return %NULL on an error.
6026 * Returns: (transfer full): a string with the data that was read
6033 * Interface for initializable objects.
6040 * g_cancellable_connect:
6041 * @cancellable: A #GCancellable.
6042 * @callback: The #GCallback to connect.
6043 * @data: Data to pass to @callback.
6044 * @data_destroy_func: Free function for @data or %NULL.
6046 * Convenience function to connect to the #GCancellable::cancelled
6047 * signal. Also handles the race condition that may happen
6048 * if the cancellable is cancelled right before connecting.
6049 * time of the connect if @cancellable is already cancelled,
6050 * or when @cancellable is cancelled in some thread.
6051 * disconnected, or immediately if the cancellable is already
6053 * See #GCancellable::cancelled for details on how to use this.
6056 * Returns: The id of the signal handler or 0 if @cancellable has already
6062 * GSettingsBindFlags:
6063 * @G_SETTINGS_BIND_DEFAULT: Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal>
6064 * @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes. It is an error to use this flag if the property is not writable.
6065 * @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes. It is an error to use this flag if the property is not readable.
6066 * @G_SETTINGS_BIND_NO_SENSITIVITY: Do not try to bind a "sensitivity" property to the writability of the setting
6067 * @G_SETTINGS_BIND_GET_NO_CHANGES: When set in addition to #G_SETTINGS_BIND_GET, set the #GObject property value initially from the setting, but do not listen for changes of the setting
6068 * @G_SETTINGS_BIND_INVERT_BOOLEAN: When passed to g_settings_bind(), uses a pair of mapping functions that invert the boolean value when mapping between the setting and the property. The setting and property must both be booleans. You can not pass this flag to g_settings_bind_with_mapping().
6070 * Flags used when creating a binding. These flags determine in which
6071 * direction the binding works. The default is to synchronize in both
6077 * g_tls_connection_get_require_close_notify:
6078 * @conn: a #GTlsConnection
6080 * Tests whether or not @conn expects a proper TLS close notification
6081 * when the connection is closed. See
6082 * g_tls_connection_set_require_close_notify() for details.
6085 * Returns: %TRUE if @conn requires a proper TLS close
6092 * @class_size: Size of the class structure (required for interface, classed and instantiatable types).
6093 * @base_init: Location of the base initialization function (optional).
6094 * @base_finalize: Location of the base finalization function (optional).
6095 * @class_init: 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, and to do type-specific setup such as registering signals and object properties.
6096 * @class_finalize: Location of the class finalization function for classed and instantiatable types. Location fo the default vtable finalization function for interface types. (optional)
6097 * @class_data: User-supplied data passed to the class init/finalize functions.
6098 * @instance_size: Size of the instance (object) structure (required for instantiatable types only).
6099 * @n_preallocs: 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 <link linkend="glib-Memory-Slices">slice allocator</link> now.
6100 * @instance_init: Location of the instance initialization function (optional, for instantiatable types only).
6101 * @value_table: A #GTypeValueTable function table for generic handling of GValues of this type (usually only useful for fundamental types).
6103 * This structure is used to provide the type system with the information
6104 * required to initialize and destruct (finalize) a type's class and
6106 * The initialized structure is passed to the g_type_register_static() function
6107 * (or is copied into the provided #GTypeInfo structure in the
6108 * g_type_plugin_complete_type_info()). The type system will perform a deep
6109 * copy of this structure, so its memory does not need to be persistent
6110 * across invocation of g_type_register_static().
6115 * GSimpleAction:enabled:
6117 * If @action is currently enabled.
6118 * If the action is disabled then calls to g_simple_action_activate() and
6119 * g_simple_action_set_state() have no effect.
6126 * g_app_launch_context_new:
6128 * Creates a new application launch context. This is not normally used,
6129 * instead you instantiate a subclass of this, such as #GdkAppLaunchContext.
6131 * Returns: a #GAppLaunchContext.
6136 * g_simple_async_result_set_op_res_gpointer: (skip)
6137 * @simple: a #GSimpleAsyncResult.
6138 * @op_res: a pointer result from an asynchronous function.
6139 * @destroy_op_res: a #GDestroyNotify function.
6141 * Sets the operation result within the asynchronous result to a pointer.
6146 * G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE:
6148 * A key in the "access" namespace for getting execution privileges.
6149 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
6150 * This attribute will be %TRUE if the user is able to execute the file.
6155 * g_unix_mount_get_device_path:
6156 * @mount_entry: a #GUnixMount.
6158 * Gets the device path for a unix mount.
6160 * Returns: a string containing the device path.
6165 * g_dbus_error_strip_remote_error:
6166 * @error: A #GError.
6168 * Looks for extra information in the error message used to recover
6169 * the D-Bus error name and strips it if found. If stripped, the
6170 * message field in @error will correspond exactly to what was
6171 * received on the wire.
6172 * This is typically used when presenting errors to the end user.
6174 * Returns: %TRUE if information was stripped, %FALSE otherwise.
6181 * @parent_instance: private #GParamSpec portion
6182 * @minimum: minimum value for the property specified
6183 * @maximum: maximum value for the property specified
6184 * @default_value: default value for the property specified
6186 * A #GParamSpec derived structure that contains the meta data for integer properties.
6191 * G_PARAM_SPEC_ULONG:
6192 * @pspec: a valid #GParamSpec instance
6194 * Cast a #GParamSpec instance into a #GParamSpecULong.
6199 * g_socket_control_message_deserialize:
6200 * @level: a socket level
6201 * @type: a socket control message type for the given @level
6202 * @size: the size of the data in bytes
6203 * @data: (array length=size) (element-type guint8): pointer to the message data
6205 * Tries to deserialize a socket control message of a given
6206 * of #GSocketControlMessage if they can understand this kind
6207 * of message and if so deserialize it into a #GSocketControlMessage.
6208 * If there is no implementation for this kind of control message, %NULL
6211 * Returns: (transfer full): the deserialized message or %NULL
6217 * g_file_enumerate_children:
6218 * @file: input #GFile.
6219 * @attributes: an attribute query string.
6220 * @flags: a set of #GFileQueryInfoFlags.
6221 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6222 * @error: #GError for error reporting.
6224 * Gets the requested information about the files in a directory. The result
6225 * is a #GFileEnumerator object that will give out #GFileInfo objects for
6226 * all the files in the directory.
6227 * The @attributes value is a string that specifies the file attributes that
6228 * should be gathered. It is not an error if it's not possible to read a particular
6229 * requested attribute from a file - it just won't be set. @attributes should
6230 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
6231 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
6232 * namespace. An example attribute query be "standard::*,owner::user".
6233 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
6234 * If @cancellable is not %NULL, then the operation can be cancelled by
6235 * triggering the cancellable object from another thread. If the operation
6236 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6237 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
6238 * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
6239 * Other errors are possible too.
6240 * Free the returned object with g_object_unref().
6242 * Returns: (transfer full): A #GFileEnumerator if successful, %NULL on error.
6247 * GTlsCertificate:issuer:
6249 * A #GTlsCertificate representing the entity that issued this
6250 * certificate. If %NULL, this means that the certificate is either
6251 * self-signed, or else the certificate of the issuer is not
6259 * g_output_stream_clear_pending:
6260 * @stream: output stream
6262 * Clears the pending flag on @stream.
6269 * The #GType for #GString.
6274 * g_permission_get_can_release:
6275 * @permission: a #GPermission instance
6276 * @returns: the value of the 'can-release' property
6278 * Gets the value of the 'can-release' property. This property is %TRUE
6279 * if it is generally possible to release the permission by calling
6280 * g_permission_release().
6287 * g_mount_get_default_location:
6288 * @mount: a #GMount.
6290 * Gets the default location of @mount. The default location of the given
6291 * the home directory, or the root of the volume).
6292 * The returned object should be unreffed with
6293 * g_object_unref() when no longer needed.
6295 * Returns: (transfer full): a #GFile.
6300 * G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME:
6302 * Extension point for default handler to URI association. See
6303 * <link linkend="extending-gio">Extending GIO</link>.
6308 * g_io_scheduler_job_send_to_mainloop:
6309 * @job: a #GIOSchedulerJob
6310 * @func: a #GSourceFunc callback that will be called in the original thread
6311 * @user_data: data to pass to @func
6312 * @notify: a #GDestroyNotify for @user_data, or %NULL
6314 * Used from an I/O job to send a callback to be run in the thread
6315 * that the job was started from, waiting for the result (and thus
6316 * blocking the I/O job).
6318 * Returns: The return value of @func
6324 * @class: a #GFlagsClass
6326 * Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS
6332 * SECTION:gdatainputstrea:
6333 * @short_description: Data Input Stream
6334 * @include: gio/gio.h
6335 * @see_also: #GInputStream
6337 * Data input stream implements #GInputStream and includes functions for
6338 * reading structured data directly from a binary input stream.
6343 * g_socket_client_get_family:
6344 * @client: a #GSocketClient.
6346 * Gets the socket family of the socket client.
6347 * See g_socket_client_set_family() for details.
6349 * Returns: a #GSocketFamily
6355 * g_simple_async_result_new:
6356 * @source_object: (allow-none): a #GObject, or %NULL.
6357 * @callback: (scope async): a #GAsyncReadyCallback.
6358 * @user_data: (closure): user data passed to @callback.
6359 * @source_tag: the asynchronous function.
6361 * Creates a #GSimpleAsyncResult.
6363 * Returns: a #GSimpleAsyncResult.
6368 * g_content_type_get_mime_type:
6369 * @type: a content type string
6371 * Gets the mime type for the content type, if one is registered.
6372 * or %NULL if unknown.
6374 * Returns: (allow-none): the registered mime type for the given @type,
6379 * G_FILE_ATTRIBUTE_OWNER_GROUP:
6381 * A key in the "owner" namespace for getting the file owner's group.
6382 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
6387 * g_file_find_enclosing_mount_async:
6389 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
6390 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6391 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
6392 * @user_data: (closure): the data to pass to callback function
6394 * Asynchronously gets the mount for the file.
6395 * For more details, see g_file_find_enclosing_mount() which is
6396 * the synchronous version of this call.
6397 * When the operation is finished, @callback will be called. You can then call
6398 * g_file_find_enclosing_mount_finish() to get the result of the operation.
6403 * GLoadableIconIface:
6404 * @g_iface: The parent interface.
6405 * @load: Loads an icon.
6406 * @load_async: Loads an icon asynchronously.
6407 * @load_finish: Finishes an asynchronous icon load.
6409 * Interface for icons that can be loaded as a stream.
6414 * g_file_open_readwrite_async:
6415 * @file: input #GFile.
6416 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
6417 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6418 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
6419 * @user_data: (closure): the data to pass to callback function
6421 * Asynchronously opens @file for reading and writing.
6422 * For more details, see g_file_open_readwrite() which is
6423 * the synchronous version of this call.
6424 * When the operation is finished, @callback will be called. You can then call
6425 * g_file_open_readwrite_finish() to get the result of the operation.
6432 * SECTION:gproxyresolve:
6433 * @short_description: Asynchronous and cancellable network proxy resolver
6434 * @include: gio/gio.h
6436 * #GProxyResolver provides synchronous and asynchronous network proxy
6437 * resolution. #GProxyResolver is used within #GClientSocket through
6438 * the method g_socket_connectable_proxy_enumerate().
6443 * g_socket_client_set_enable_proxy:
6444 * @client: a #GSocketClient.
6445 * @enable: whether to enable proxies
6447 * Sets whether or not @client attempts to make connections via a
6448 * proxy server. When enabled (the default), #GSocketClient will use a
6449 * #GProxyResolver to determine if a proxy protocol such as SOCKS is
6450 * needed, and automatically do the necessary proxy negotiation.
6459 * An opaque structure representing a checksumming operation.
6460 * To create a new GChecksum, use g_checksum_new(). To free
6461 * a GChecksum, use g_checksum_free().
6468 * G_CCLOSURE_SWAP_DATA:
6469 * @cclosure: a #GCClosure
6471 * Checks whether the user data of the #GCClosure should be passed as the
6472 * first parameter to the callback. See g_cclosure_new_swap().
6474 * Returns: %TRUE if data has to be swapped.
6479 * G_TYPE_IS_DEEP_DERIVABLE:
6480 * @type: A #GType value.
6482 * Checks if @type is a deep derivable type. A deep derivable type
6483 * can be used as the base class of a deep (multi-level) class hierarchy.
6485 * Returns: %TRUE on success.
6490 * g_file_attribute_matcher_matches:
6491 * @matcher: a #GFileAttributeMatcher.
6492 * @attribute: a file attribute key.
6494 * Checks if an attribute will be matched by an attribute matcher. If
6495 * the matcher was created with the "*" matching string, this function
6496 * will always return %TRUE.
6498 * Returns: %TRUE if @attribute matches @matcher. %FALSE otherwise.
6503 * g_resolver_lookup_service_finish:
6504 * @resolver: a #GResolver
6505 * @result: the result passed to your #GAsyncReadyCallback
6506 * @error: return location for a #GError, or %NULL
6508 * Retrieves the result of a previous call to
6509 * g_resolver_lookup_service_async().
6510 * If the DNS resolution failed, @error (if non-%NULL) will be set to
6511 * a value from #GResolverError. If the operation was cancelled,
6512 * or %NULL on error. See g_resolver_lookup_service() for more details.
6514 * Returns: (element-type GSrvTarget) (transfer full): a #GList of #GSrvTarget,
6520 * g_file_info_set_attribute_int32:
6521 * @info: a #GFileInfo.
6522 * @attribute: a file attribute key.
6523 * @attr_value: a signed 32-bit integer
6525 * Sets the @attribute to contain the given @attr_value,
6531 * g_socket_client_connect_to_service_finish:
6532 * @client: a #GSocketClient.
6533 * @result: a #GAsyncResult.
6534 * @error: a #GError location to store the error occuring, or %NULL to ignore.
6536 * Finishes an async connect operation. See g_socket_client_connect_to_service_async()
6538 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
6545 * @str: the untranslated string
6546 * @data: user data specified when installing the function, e.g. in g_option_group_set_translate_func()
6548 * The type of functions which are used to translate user-visible
6549 * strings, for <option>--help</option> output.
6550 * The returned string is owned by GLib and must not be freed.
6552 * Returns: a translation of the string for the current locale.
6557 * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
6559 * The string used to obtain a Hal UDI with g_volume_get_identifier().
6564 * g_cancellable_cancel:
6565 * @cancellable: a #GCancellable object.
6567 * Will set @cancellable to cancelled, and will emit the
6568 * #GCancellable::cancelled signal. (However, see the warning about
6569 * race conditions in the documentation for that signal if you are
6570 * planning to connect to it.)
6571 * This function is thread-safe. In other words, you can safely call
6572 * it from a thread other than the one running the operation that was
6573 * passed the @cancellable.
6574 * The convention within gio is that cancelling an asynchronous
6575 * operation causes it to complete asynchronously. That is, if you
6576 * cancel the operation from the same thread in which it is running,
6577 * then the operation's #GAsyncReadyCallback will not be invoked until
6578 * the application returns to the main loop.
6583 * g_dbus_arg_info_ref:
6584 * @info: A #GDBusArgInfo
6586 * If @info is statically allocated does nothing. Otherwise increases
6587 * the reference count.
6589 * Returns: The same @info.
6596 * @g_iface: The parent interface.
6597 * @changed: Changed signal that is emitted when the volume's state has changed.
6598 * @removed: The removed signal that 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.
6599 * @get_name: Gets a string containing the name of the #GVolume.
6600 * @get_icon: Gets a #GIcon for the #GVolume.
6601 * @get_uuid: Gets the UUID for the #GVolume. 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.
6602 * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
6603 * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
6604 * @can_mount: Returns %TRUE if the #GVolume can be mounted.
6605 * @can_eject: Checks if a #GVolume can be ejected.
6606 * @mount_fn: Mounts a given #GVolume. #GVolume implementations must emit the #GMountOperation::aborted signal before completing a mount operation that is aborted while awaiting input from the user through a #GMountOperation instance.
6607 * @mount_finish: Finishes a mount operation.
6608 * @eject: Ejects a given #GVolume.
6609 * @eject_finish: Finishes an eject operation.
6610 * @get_identifier: Returns the <link linkend="volume-identifier">identifier</link> of the given kind, or %NULL if the #GVolume doesn't have one.
6611 * @enumerate_identifiers: Returns an array strings listing the kinds of <link linkend="volume-identifier">identifiers</link> which the #GVolume has.
6612 * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
6613 * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if it is not known.
6614 * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
6615 * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
6617 * Interface for implementing operations for mountable volumes.
6622 * g_file_attribute_matcher_enumerate_next:
6623 * @matcher: a #GFileAttributeMatcher.
6625 * Gets the next matched attribute from a #GFileAttributeMatcher.
6626 * no more attribute exist.
6628 * Returns: a string containing the next attribute or %NULL if
6633 * G_TYPE_INSTANCE_GET_PRIVATE:
6634 * @instance: the instance of a type deriving from @private_type.
6635 * @g_type: the type identifying which private data to retrieve.
6636 * @c_type: The C type for the private structure.
6638 * Gets the private structure for a particular type.
6639 * The private structure must have been registered in the
6640 * class_init function with g_type_class_add_private().
6641 * This macro should only be used in type implementations.
6644 * Returns: a pointer to the private data structure.
6649 * g_file_enumerator_close:
6650 * @enumerator: a #GFileEnumerator.
6651 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6652 * @error: location to store the error occuring, or %NULL to ignore
6654 * Releases all resources used by this enumerator, making the
6655 * enumerator return %G_IO_ERROR_CLOSED on all calls.
6656 * This will be automatically called when the last reference
6657 * is dropped, but you might want to call this function to make
6658 * sure resources are released as early as possible.
6660 * Returns: #TRUE on success or #FALSE on error.
6665 * g_socket_control_message_get_msg_type:
6666 * @message: a #GSocketControlMessage
6668 * Returns the protocol specific type of the control message.
6669 * For instance, for UNIX fd passing this would be SCM_RIGHTS.
6671 * Returns: an integer describing the type of control message
6677 * GThemedIcon:names:
6679 * A %NULL-terminated array of icon names.
6686 * Seek object for streaming operations.
6691 * g_memory_output_stream_get_data:
6692 * @ostream: a #GMemoryOutputStream
6694 * Gets any loaded data from the @ostream.
6695 * Note that the returned pointer may become invalid on the next
6696 * write or truncate operation on the stream.
6698 * Returns: (transfer none): pointer to the stream's data
6703 * GFileMonitorEvent:
6704 * @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
6705 * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
6706 * @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
6707 * @G_FILE_MONITOR_EVENT_CREATED: a file was created.
6708 * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
6709 * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
6710 * @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was unmounted.
6711 * @G_FILE_MONITOR_EVENT_MOVED: the file was moved.
6713 * Specifies what type of event a monitor event is.
6718 * GTlsClientConnection:validation-flags:
6720 * What steps to perform when validating a certificate received from
6721 * a server. Server certificates that fail to validate in all of the
6722 * ways indicated here will be rejected unless the application
6723 * overrides the default via #GTlsConnection::accept-certificate.
6730 * g_data_input_stream_read_upto_finish:
6731 * @stream: a #GDataInputStream
6732 * @result: the #GAsyncResult that was provided to the callback
6733 * @length: (out): a #gsize to get the length of the data read in
6734 * @error: #GError for error reporting
6736 * Finish an asynchronous call started by
6737 * g_data_input_stream_read_upto_async().
6738 * Note that this function does <emphasis>not</emphasis> consume the
6739 * stop character. You have to use g_data_input_stream_read_byte() to
6740 * get it before calling g_data_input_stream_read_upto_async() again.
6741 * before encountering any of the stop characters. Set @length to
6742 * a #gsize to get the length of the string. This function will
6743 * return %NULL on an error.
6745 * Returns: (transfer full): a string with the data that was read
6751 * g_simple_action_group_remove:
6752 * @simple: a #GSimpleActionGroup
6753 * @action_name: the name of the action
6755 * Removes the named action from the action group.
6756 * If no action of this name is in the group then nothing happens.
6763 * g_output_stream_splice:
6764 * @stream: a #GOutputStream.
6765 * @source: a #GInputStream.
6766 * @flags: a set of #GOutputStreamSpliceFlags.
6767 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6768 * @error: a #GError location to store the error occuring, or %NULL to ignore.
6770 * Splices an input stream into an output stream.
6771 * -1 if an error occurred.
6773 * Returns: a #gssize containing the size of the data spliced, or
6778 * G_TYPE_FLAG_RESERVED_ID_BIT:
6780 * A bit in the type number that's supposed to be left untouched.
6785 * GIOStreamSpliceFlags:
6786 * @G_IO_STREAM_SPLICE_NONE: Do not close either stream.
6787 * @G_IO_STREAM_SPLICE_CLOSE_STREAM1: Close the first stream after the splice.
6788 * @G_IO_STREAM_SPLICE_CLOSE_STREAM2: Close the second stream after the splice.
6789 * @G_IO_STREAM_SPLICE_WAIT_FOR_BOTH: Wait for both splice operations to finish before calling the callback.
6791 * GIOStreamSpliceFlags determine how streams should be spliced.
6798 * G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITER:
6800 * Subcomponent delimiter characters as defined in RFC 3986. Includes "!$&'()*+,;=".
6805 * g_socket_client_connect_to_uri:
6806 * @client: a #GSocketClient
6807 * @uri: A network URI
6808 * @default_port: the default port to connect to
6809 * @cancellable: (allow-none): a #GCancellable, or %NULL
6810 * @error: a pointer to a #GError, or %NULL
6812 * This is a helper function for g_socket_client_connect().
6813 * Attempts to create a TCP connection with a network URI.
6814 * component. If a port is not specified in the URI, @default_port
6815 * will be used. TLS will be negotiated if #GSocketClient:tls is %TRUE.
6816 * (#GSocketClient does not know to automatically assume TLS for
6817 * certain URI schemes.)
6818 * Using this rather than g_socket_client_connect() or
6819 * g_socket_client_connect_to_host() allows #GSocketClient to
6820 * determine when to use application-specific proxy protocols.
6821 * Upon a successful connection, a new #GSocketConnection is constructed
6822 * and returned. The caller owns this new object and must drop their
6823 * reference to it when finished with it.
6824 * In the event of any failure (DNS error, service not found, no hosts
6825 * connectable) %NULL is returned and @error (if non-%NULL) is set
6828 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
6834 * g_unix_mount_points_get:
6835 * @time_read: (allow-none): guint64 to contain a timestamp.
6837 * Gets a #GList of #GUnixMountPoint containing the unix mount points.
6838 * If @time_read is set, it will be filled with the mount timestamp,
6839 * allowing for checking if the mounts have changed with
6840 * g_unix_mounts_points_changed_since().
6842 * Returns: (element-type utf8) (transfer full): a #GList of the UNIX mountpoints.
6847 * GDataStreamByteOrder:
6848 * @G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN: Selects Big Endian byte order.
6849 * @G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN: Selects Little Endian byte order.
6850 * @G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN: Selects endianness based on host machine's architecture.
6852 * #GDataStreamByteOrder is used to ensure proper endianness of streaming data sources
6853 * across various machine architectures.
6858 * g_mount_guess_content_type_sync:
6860 * @force_rescan: Whether to force a rescan of the content. Otherwise a cached result will be used if available
6861 * @cancellable: optional #GCancellable object, %NULL to ignore
6862 * @error: a #GError location to store the error occuring, or %NULL to ignore
6864 * Tries to guess the type of content stored on @mount. Returns one or
6865 * more textual identifiers of well-known content types (typically
6866 * prefixed with "x-content/"), e.g. x-content/image-dcf for camera
6867 * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
6868 * specification for more on x-content types.
6869 * This is an synchronous operation and as such may block doing IO;
6870 * see g_mount_guess_content_type() for the asynchronous version.
6871 * Caller should free this array with g_strfreev() when done with it.
6873 * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error.
6879 * g_async_initable_init_async:
6880 * @initable: a #GAsyncInitable.
6881 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the operation.
6882 * @cancellable: optional #GCancellable object, %NULL to ignore.
6883 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6884 * @user_data: the data to pass to callback function
6886 * Starts asynchronous initialization of the object implementing the
6887 * interface. This must be done before any real use of the object after
6888 * initial construction. If the object also implements #GInitable you can
6889 * optionally call g_initable_init() instead.
6890 * When the initialization is finished, @callback will be called. You can
6891 * then call g_async_initable_init_finish() to get the result of the
6893 * Implementations may also support cancellation. If @cancellable is not
6894 * %NULL, then initialization can be cancelled by triggering the cancellable
6895 * object from another thread. If the operation was cancelled, the error
6896 * %G_IO_ERROR_CANCELLED will be returned. If @cancellable is not %NULL, and
6897 * the object doesn't support cancellable initialization, the error
6898 * %G_IO_ERROR_NOT_SUPPORTED will be returned.
6899 * If this function is not called, or returns with an error, then all
6900 * operations on the object should fail, generally returning the
6901 * error %G_IO_ERROR_NOT_INITIALIZED.
6902 * to this function with the same argument should return the same results.
6903 * Only the first call initializes the object; further calls return the result
6904 * of the first call. This is so that it's safe to implement the singleton
6905 * pattern in the GObject constructor function.
6906 * For classes that also support the #GInitable interface, the default
6907 * implementation of this method will run the g_initable_init() function
6908 * in a thread, so if you want to support asynchronous initialization via
6909 * threads, just implement the #GAsyncInitable interface without overriding
6910 * any interface methods.
6912 * Implementations of this method must be idempotent: i.e. multiple calls
6918 * g_file_new_for_path:
6919 * @path: a string containing a relative or absolute path. The string must be encoded in the glib filename encoding.
6921 * Constructs a #GFile for a given path. This operation never
6922 * fails, but the returned object might not support any I/O
6923 * operation if @path is malformed.
6925 * Returns: (transfer full): a new #GFile for the given @path.
6931 * @struct_type: the type of the elements to allocate
6932 * @n_structs: the number of elements to allocate
6934 * Allocates @n_structs elements of type @struct_type.
6935 * The returned pointer is cast to a pointer to the given type.
6936 * If @n_structs is 0 it returns %NULL.
6937 * Care is taken to avoid overflow when calculating the size of the allocated block.
6938 * Since the returned pointer is already casted to the right type,
6939 * it is normally unnecessary to cast it explicitly, and doing
6940 * so might hide memory allocation errors.
6942 * Returns: a pointer to the allocated memory, cast to a pointer to @struct_type
6947 * g_file_copy_attributes:
6948 * @source: a #GFile with attributes.
6949 * @destination: a #GFile to copy attributes to.
6950 * @flags: a set of #GFileCopyFlags.
6951 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6952 * @error: a #GError, %NULL to ignore.
6954 * Copies the file attributes from @source to @destination.
6955 * Normally only a subset of the file attributes are copied,
6956 * those that are copies in a normal file copy operation
6957 * (which for instance does not include e.g. owner). However
6958 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
6959 * all the metadata that is possible to copy is copied. This
6960 * is useful when implementing move by copy + delete source.
6962 * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise.
6967 * G_IS_PARAM_SPEC_CHAR:
6968 * @pspec: a valid #GParamSpec instance
6970 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR.
6972 * Returns: %TRUE on success.
6977 * g_dbus_message_get_byte_order:
6978 * @message: A #GDBusMessage.
6980 * Gets the byte order of @message.
6982 * Returns: The byte order.
6988 * @src_value: Source value.
6989 * @dest_value: Target value.
6991 * The type of value transformation functions which can be registered with
6992 * g_value_register_transform_func().
6997 * g_app_info_get_default_for_type:
6998 * @content_type: the content type to find a #GAppInfo for
6999 * @must_support_uris: if %TRUE, the #GAppInfo is expected to support URIs
7001 * Gets the #GAppInfo that corresponds to a given content type.
7004 * Returns: (transfer full): #GAppInfo for given @content_type or
7009 * G_IS_PARAM_SPEC_UNICHAR:
7010 * @pspec: a valid #GParamSpec instance
7012 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR.
7014 * Returns: %TRUE on success.
7020 * @settings: a #GSettings instance
7022 * Applies any changes that have been made to the settings. This
7023 * function does nothing unless @settings is in 'delay-apply' mode;
7024 * see g_settings_delay(). In the normal case settings are always
7025 * applied immediately.
7030 * g_file_info_get_symlink_target:
7031 * @info: a #GFileInfo.
7033 * Gets the symlink target for a given #GFileInfo.
7035 * Returns: a string containing the symlink target.
7040 * G_SIGNAL_TYPE_STATIC_SCOPE:
7042 * This macro flags signal argument types for which the signal system may
7043 * assume that instances thereof remain persistent across all signal emissions
7044 * they are used in. This is only useful for non ref-counted, value-copy types.
7045 * To flag a signal argument in this way, add
7046 * <literal>| G_SIGNAL_TYPE_STATIC_SCOPE</literal> to the corresponding argument
7047 * of g_signal_new().
7049 * g_signal_new ("size_request",
7050 * G_TYPE_FROM_CLASS (gobject_class),
7051 * G_SIGNAL_RUN_FIRST,
7052 * G_STRUCT_OFFSET (GtkWidgetClass, size_request),
7054 * _gtk_marshal_VOID__BOXED,
7056 * GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
7062 * g_output_stream_is_closed:
7063 * @stream: a #GOutputStream.
7065 * Checks if an output stream has already been closed.
7067 * Returns: %TRUE if @stream is closed. %FALSE otherwise.
7072 * g_file_load_partial_contents_finish:
7073 * @file: input #GFile.
7074 * @res: a #GAsyncResult.
7075 * @contents: (out) (transfer full): a location to place the contents of the file.
7076 * @length: (out) (allow-none): a location to place the length of the contents of the file, or %NULL if the length is not needed
7077 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file, or %NULL if the entity tag is not needed
7078 * @error: a #GError, or %NULL
7080 * Finishes an asynchronous partial load operation that was started
7081 * with g_file_load_partial_contents_async(). The data is always
7082 * zero-terminated, but this is not included in the resultant @length.
7083 * The returned @content should be freed with g_free() when no longer
7085 * present, it will be set appropriately.
7087 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7092 * g_socket_listener_add_address:
7093 * @listener: a #GSocketListener
7094 * @address: a #GSocketAddress
7095 * @type: a #GSocketType
7096 * @protocol: a #GSocketProtocol
7097 * @source_object: (allow-none): Optional #GObject identifying this source
7098 * @effective_address: (out) (allow-none): location to store the address that was bound to, or %NULL.
7099 * @error: #GError for error reporting, or %NULL to ignore.
7101 * Creates a socket of type @type and protocol @protocol, binds
7102 * it to @address and adds it to the set of sockets we're accepting
7104 * Note that adding an IPv6 address, depending on the platform,
7105 * may or may not result in a listener that also accepts IPv4
7106 * connections. For more determinstic behaviour, see
7107 * g_socket_listener_add_inet_port().
7108 * to accept to identify this particular source, which is
7109 * useful if you're listening on multiple addresses and do
7110 * different things depending on what address is connected to.
7111 * If successful and @effective_address is non-%NULL then it will
7112 * be set to the address that the binding actually occured at. This
7113 * is helpful for determining the port number that was used for when
7114 * requested, belongs to the caller and must be freed.
7116 * Requesting a binding to port 0 (ie: "any port"). This address, if
7117 * Returns: %TRUE on success, %FALSE on error.
7123 * g_socket_get_socket_type:
7124 * @socket: a #GSocket.
7126 * Gets the socket type of the socket.
7128 * Returns: a #GSocketType
7134 * G_VALUE_HOLDS_BOXED:
7135 * @value: a valid #GValue structure
7137 * Checks whether the given #GValue can hold values derived from type %G_TYPE_BOXED.
7139 * Returns: %TRUE on success.
7146 * A subclass of GIOStream for opened files. This adds
7147 * a few file-specific operations and seeking and truncating.
7148 * #GFileIOStream implements GSeekable.
7153 * g_vfs_get_supported_uri_schemes:
7156 * Gets a list of URI schemes supported by @vfs.
7157 * The returned array belongs to GIO and must
7158 * not be freed or modified.
7160 * Returns: (transfer none): a %NULL-terminated array of strings.
7167 * A GRegex is the "compiled" form of a regular expression pattern. This
7168 * structure is opaque and its fields cannot be accessed directly.
7175 * GFileAttributeInfoList:
7176 * @infos: an array of #GFileAttributeInfo<!-- -->s.
7177 * @n_infos: the number of values in the array.
7179 * Acts as a lightweight registry for possible valid file attributes.
7180 * The registry stores Key-Value pair formats as #GFileAttributeInfo<!-- -->s.
7186 * @mount: the object on which the signal is emitted
7188 * Emitted when the mount has been changed.
7193 * g_action_get_state_hint:
7194 * @action: a #GAction
7196 * Requests a hint about the valid range of values for the state of
7197 * If %NULL is returned it either means that the action is not stateful
7198 * or that there is no hint about the valid range of values for the
7199 * state of the action.
7200 * If a #GVariant array is returned then each item in the array is a
7201 * returned then the tuple specifies the inclusive lower and upper bound
7202 * of valid values for the state.
7203 * In any case, the information is merely a hint. It may be possible to
7204 * have a state value outside of the hinted range and setting a value
7205 * within the range may fail.
7206 * The return value (if non-%NULL) should be freed with
7207 * g_variant_unref() when it is no longer required.
7209 * Possible value for the state. if a #gvariant pair (ie: two-tuple) is
7210 * Returns: (transfer full): the state range hint
7216 * g_action_group_activate_action:
7217 * @action_group: a #GActionGroup
7218 * @action_name: the name of the action to activate
7219 * @parameter: (allow-none): parameters to the activation
7221 * Activate the named action within @action_group.
7222 * If the action is expecting a parameter, then the correct type of
7223 * parameter must be given as @parameter. If the action is expecting no
7224 * parameters then @parameter must be %NULL. See
7225 * g_action_group_get_parameter_type().
7233 * @loop: a #GMainLoop
7235 * Stops the #GMainLoop.
7236 * If g_main_run() was called to run the #GMainLoop, it will now return.
7238 * Deprecated: 2.2: Use g_main_loop_quit() instead
7243 * g_file_info_get_edit_name:
7244 * @info: a #GFileInfo.
7246 * Gets the edit name for a file.
7248 * Returns: a string containing the edit name.
7253 * g_dbus_address_get_stream:
7254 * @address: A valid D-Bus address.
7255 * @cancellable: A #GCancellable or %NULL.
7256 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
7257 * @user_data: Data to pass to @callback.
7259 * Asynchronously connects to an endpoint specified by @address and
7260 * sets up the connection so it is in a state to run the client-side
7261 * of the D-Bus authentication conversation.
7262 * When the operation is finished, @callback will be invoked. You can
7263 * then call g_dbus_address_get_stream_finish() to get the result of
7265 * This is an asynchronous failable function. See
7266 * g_dbus_address_get_stream_sync() for the synchronous version.
7273 * G_PARAM_SPEC_PARAM:
7274 * @pspec: a valid #GParamSpec instance
7276 * Casts a #GParamSpec instance into a #GParamSpecParam.
7281 * G_VALUE_HOLDS_VARIANT:
7282 * @value: a valid #GValue structure
7284 * Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT.
7286 * Returns: %TRUE on success.
7292 * SECTION:gunixsocketaddres:
7293 * @short_description: UNIX GSocketAddress
7294 * @include: gio/gunixsocketaddress.h
7296 * Support for UNIX-domain (also known as local) sockets.
7297 * UNIX domain sockets are generally visible in the filesystem.
7298 * However, some systems support abstract socket names which are not
7299 * visible in the filesystem and not affected by the filesystem
7300 * permissions, visibility, etc. Currently this is only supported
7301 * under Linux. If you attempt to use abstract sockets on other
7302 * systems, function calls may return %G_IO_ERROR_NOT_SUPPORTED
7303 * errors. You can use g_unix_socket_address_abstract_names_supported()
7304 * to see if abstract names are supported.
7305 * Note that <filename><gio/gunixsocketaddress.h></filename> belongs to
7306 * the UNIX-specific GIO interfaces, thus you have to use the
7307 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
7313 * @file: #GFile to read.
7314 * @cancellable: (allow-none): a #GCancellable
7315 * @error: a #GError, or %NULL
7317 * Opens a file for reading. The result is a #GFileInputStream that
7318 * can be used to read the contents of the file.
7319 * If @cancellable is not %NULL, then the operation can be cancelled by
7320 * triggering the cancellable object from another thread. If the operation
7321 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7322 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
7323 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
7324 * Other errors are possible too, and depend on what kind of filesystem the file is on.
7325 * Free the returned object with g_object_unref().
7328 * Returns: (transfer full): #GFileInputStream or %NULL on error.
7333 * GVolumeMonitor::volume-added:
7334 * @volume_monitor: The volume monitor emitting the signal.
7335 * @volume: a #GVolume that was added.
7337 * Emitted when a mountable volume is added to the system.
7344 * The <structname>GSource</structname> struct is an opaque data type
7345 * representing an event source.
7350 * g_volume_monitor_get_connected_drives:
7351 * @volume_monitor: a #GVolumeMonitor.
7353 * Gets a list of drives connected to the system.
7354 * The returned list should be freed with g_list_free(), after
7355 * its elements have been unreffed with g_object_unref().
7357 * Returns: (element-type GDrive) (transfer full): a #GList of connected #GDrive objects.
7362 * GDBusProxy::g-properties-changed:
7363 * @proxy: The #GDBusProxy emitting the signal.
7364 * @changed_properties: A #GVariant containing the properties that changed
7365 * @invalidated_properties: A %NULL terminated array of properties that was invalidated
7367 * Emitted when one or more D-Bus properties on @proxy changes. The
7368 * local cache has already been updated when this signal fires. Note
7369 * that both @changed_properties and @invalidated_properties are
7370 * guaranteed to never be %NULL (either may be empty though).
7371 * This signal corresponds to the
7372 * <literal>PropertiesChanged</literal> D-Bus signal on the
7373 * <literal>org.freedesktop.DBus.Properties</literal> interface.
7380 * g_simple_async_result_propagate_error:
7381 * @simple: a #GSimpleAsyncResult.
7382 * @dest: (out): a location to propagate the error to.
7384 * Propagates an error from within the simple asynchronous result to
7385 * a given destination.
7387 * Returns: %TRUE if the error was propagated to @dest. %FALSE otherwise.
7392 * g_file_replace_readwrite_finish:
7393 * @file: input #GFile.
7394 * @res: a #GAsyncResult.
7395 * @error: a #GError, or %NULL
7397 * Finishes an asynchronous file replace operation started with
7398 * g_file_replace_readwrite_async().
7399 * Free the returned object with g_object_unref().
7401 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
7407 * G_FILE_ATTRIBUTE_FILESYSTEM_READONLY:
7409 * A key in the "filesystem" namespace for checking if the file system
7410 * is read only. Is set to %TRUE if the file system is read only.
7411 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
7417 * @schema: the name of the schema
7418 * @returns: a new #GSettings object
7420 * Creates a new #GSettings object with a given schema.
7421 * Signals on the newly created #GSettings object will be dispatched
7422 * via the thread-default #GMainContext in effect at the time of the
7423 * call to g_settings_new(). The new #GSettings will hold a reference
7424 * on the context. See g_main_context_push_thread_default().
7431 * GPollableInputStreamInterface:
7432 * @g_iface: The parent interface.
7433 * @can_poll: Checks if the #GPollableInputStream instance is actually pollable
7434 * @is_readable: Checks if the stream is readable
7435 * @create_source: Creates a #GSource to poll the stream
7436 * @read_nonblocking: Does a non-blocking read or returns %G_IO_ERROR_WOULD_BLOCK
7438 * The interface for pollable input streams.
7439 * The default implementation of @can_poll always returns %TRUE.
7440 * The default implementation of @read_nonblocking calls
7441 * g_pollable_input_stream_is_readable(), and then calls
7442 * g_input_stream_read() if it returns %TRUE. This means you only need
7443 * to override it if it is possible that your @is_readable
7444 * implementation may return %TRUE when the stream is not actually
7452 * GUnixInputStream:fd:
7454 * The file descriptor that the stream reads from.
7461 * g_io_module_query:
7463 * Optional API for GIO modules to implement.
7464 * Should return a list of all the extension points that may be
7465 * implemented in this module.
7466 * This method will not be called in normal use, however it may be
7467 * called when probing existing modules and recording which extension
7468 * points that this modle is used for. This means we won't have to
7469 * load and initialze this module unless its needed.
7470 * If this function is not implemented by the module the module will
7471 * always be loaded, initialized and then unloaded on application startup
7472 * so that it can register its extension points during init.
7473 * Note that a module need not actually implement all the extension points
7474 * that g_io_module_query returns, since the exact list of extension may
7475 * depend on runtime issues. However all extension points actually implemented
7476 * must be returned by g_io_module_query() (if defined).
7477 * When installing a module that implements g_io_module_query you must
7478 * run gio-querymodules in order to build the cache files required for
7480 * extension points of the module. The array must be suitable for
7481 * freeing with g_strfreev().
7483 * Returns: (transfer full): A %NULL-terminated array of strings, listing the supported
7489 * g_file_io_stream_query_info_async:
7490 * @stream: a #GFileIOStream.
7491 * @attributes: a file attribute query string.
7492 * @io_priority: the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.
7493 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7494 * @callback: (scope async): callback to call when the request is satisfied
7495 * @user_data: (closure): the data to pass to callback function
7497 * Asynchronously queries the @stream for a #GFileInfo. When completed,
7498 * finish the operation with g_file_io_stream_query_info_finish().
7499 * For the synchronous version of this function, see
7500 * g_file_io_stream_query_info().
7507 * g_io_extension_point_register:
7508 * @name: The name of the extension point
7510 * Registers an extension point.
7511 * and should not be freed
7513 * Returns: the new #GIOExtensionPoint. This object is owned by GIO
7518 * g_vfs_get_file_for_uri:
7520 * @uri: a string containing a URI
7522 * Gets a #GFile for @uri.
7523 * This operation never fails, but the returned object
7524 * might not support any I/O operation if the URI
7525 * is malformed or if the URI scheme is not supported.
7526 * Free the returned object with g_object_unref().
7528 * Returns: (transfer full): a #GFile.
7533 * g_simple_async_result_new_from_error:
7534 * @source_object: (allow-none): a #GObject, or %NULL.
7535 * @callback: (scope async): a #GAsyncReadyCallback.
7536 * @user_data: (closure): user data passed to @callback.
7539 * Creates a #GSimpleAsyncResult from an error condition.
7541 * Returns: a #GSimpleAsyncResult.
7547 * @may_block: set to %TRUE if it should block (i.e. wait) until an event source becomes ready. It will return after an event source has been processed. If set to %FALSE it will return immediately if no event source is ready to be processed.
7549 * Runs a single iteration for the default #GMainContext.
7551 * Returns: %TRUE if more events are pending.
7552 * Deprecated: 2.2: Use g_main_context_iteration() instead.
7557 * G_TYPE_PARAM_GTYPE:
7559 * The #GType of #GParamSpecGType.
7566 * g_file_info_get_sort_order:
7567 * @info: a #GFileInfo.
7569 * Gets the value of the sort_order attribute from the #GFileInfo.
7570 * See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.
7572 * Returns: a #gint32 containing the value of the "standard::sort_order" attribute.
7577 * g_themed_icon_new:
7578 * @iconname: a string containing an icon name.
7580 * Creates a new themed icon for @iconname.
7582 * Returns: (transfer full): a new #GThemedIcon.
7589 * A type in the GVariant type system.
7590 * Two types may not be compared by value; use g_variant_type_equal() or
7591 * g_variant_type_is_subtype(). May be copied using
7592 * g_variant_type_copy() and freed using g_variant_type_free().
7597 * g_dbus_message_get_unix_fd_list:
7598 * @message: A #GDBusMessage.
7600 * Gets the UNIX file descriptors associated with @message, if any.
7601 * This method is only available on UNIX.
7602 * associated. Do not free, this object is owned by @message.
7604 * Returns: (transfer none): A #GUnixFDList or %NULL if no file descriptors are
7610 * g_action_get_state_type:
7611 * @action: a #GAction
7613 * Queries the type of the state of @action.
7614 * g_action_new_stateful()) then this function returns the #GVariantType
7615 * of the state. This is the type of the initial value given as the
7616 * state. All calls to g_action_set_state() must give a #GVariant of
7617 * this type and g_action_get_state() will return a #GVariant of the
7619 * this function will return %NULL. In that case, g_action_get_state()
7620 * will return %NULL and you must not call g_action_set_state().
7622 * If the action is stateful (ie: was created with
7623 * If the action is not stateful (ie: created with g_action_new()) then
7624 * Returns: (allow-none): the state type, if the action is stateful
7630 * g_dbus_proxy_new_for_bus_finish:
7631 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus().
7632 * @error: Return location for error or %NULL.
7634 * Finishes creating a #GDBusProxy.
7636 * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
7642 * g_unix_mount_guess_can_eject:
7643 * @mount_entry: a #GUnixMountEntry
7645 * Guesses whether a Unix mount can be ejected.
7647 * Returns: %TRUE if @mount_entry is deemed to be ejectable.
7652 * g_drive_stop_finish:
7653 * @drive: a #GDrive.
7654 * @result: a #GAsyncResult.
7655 * @error: a #GError, or %NULL
7657 * Finishes stopping a drive.
7660 * Returns: %TRUE if the drive has been stopped successfully,
7666 * g_memory_output_stream_new: (skip)
7667 * @data: pointer to a chunk of memory to use, or %NULL
7668 * @size: the size of @data
7669 * @realloc_function: a function with realloc() semantics (like g_realloc()) to be called when @data needs to be grown, or %NULL
7670 * @destroy_function: a function to be called on @data when the stream is finalized, or %NULL
7672 * Creates a new #GMemoryOutputStream.
7673 * If @data is non-%NULL, the stream will use that for its internal storage.
7674 * If @realloc_fn is non-%NULL, it will be used for resizing the internal
7675 * storage when necessary. To construct a fixed-size output stream,
7676 * pass %NULL as @realloc_fn.
7678 * /* a stream that can grow */
7679 * stream = g_memory_output_stream_new (NULL, 0, realloc, free);
7680 * /* another stream that can grow */
7681 * stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
7682 * /* a fixed-size stream */
7683 * data = malloc (200);
7684 * stream3 = g_memory_output_stream_new (data, 200, NULL, free);
7687 * Returns: A newly created #GMemoryOutputStream object.
7692 * g_buffered_output_stream_set_buffer_size:
7693 * @stream: a #GBufferedOutputStream.
7696 * Sets the size of the internal buffer to @size.
7703 * The #GDBusConnection structure contains only private data and
7704 * should only be accessed using the provided API.
7711 * g_proxy_address_get_passwor:
7712 * @proxy: a #GProxyAddress
7714 * Gets @proxy's password.
7716 * Returns: the @proxy's password
7722 * g_file_replace_contents_async:
7723 * @file: input #GFile.
7724 * @contents: string of contents to replace the file with.
7725 * @length: the length of @contents in bytes.
7726 * @etag: (allow-none): a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
7727 * @make_backup: %TRUE if a backup should be created.
7728 * @flags: a set of #GFileCreateFlags.
7729 * @cancellable: optional #GCancellable object, %NULL to ignore.
7730 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7731 * @user_data: the data to pass to callback function
7733 * Starts an asynchronous replacement of @file with the given
7734 * current entity tag.
7735 * When this operation has completed, @callback will be called with
7736 * g_file_replace_contents_finish().
7737 * If @cancellable is not %NULL, then the operation can be cancelled by
7738 * triggering the cancellable object from another thread. If the operation
7739 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7740 * If @make_backup is %TRUE, this function will attempt to
7741 * make a backup of @file.
7747 * @G_DBUS_PROXY_FLAGS_NONE: No flags set.
7748 * @G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES: Don't load properties.
7749 * @G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS: Don't connect to signals on the remote object.
7750 * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START: If not set and the proxy if 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 proxies for well-known names.
7752 * Flags used when constructing an instance of a #GDBusProxy derived class.
7759 * g_file_info_get_attribute_object:
7760 * @info: a #GFileInfo.
7761 * @attribute: a file attribute key.
7763 * Gets the value of a #GObject attribute. If the attribute does
7764 * not contain a #GObject, %NULL will be returned.
7767 * Returns: (transfer none): a #GObject associated with the given @attribute, or
7772 * GBookmarkFileError:
7773 * @G_BOOKMARK_FILE_ERROR_INVALID_URI: URI was ill-formed
7774 * @G_BOOKMARK_FILE_ERROR_INVALID_VALUE: a requested field was not found
7775 * @G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED: a requested application did not register a bookmark
7776 * @G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND: a requested URI was not found
7777 * @G_BOOKMARK_FILE_ERROR_READ: document was ill formed
7778 * @G_BOOKMARK_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was in an unknown encoding
7779 * @G_BOOKMARK_FILE_ERROR_WRITE: an error occurred while writing
7780 * @G_BOOKMARK_FILE_ERROR_FILE_NOT_FOUND: requested file was not found
7782 * Error codes returned by bookmark file parsing.
7788 * @G_SOCKET_PROTOCOL_UNKNOWN: The protocol type is unknown
7789 * @G_SOCKET_PROTOCOL_DEFAULT: The default protocol for the family/type
7790 * @G_SOCKET_PROTOCOL_TCP: TCP over IP
7791 * @G_SOCKET_PROTOCOL_UDP: UDP over IP
7792 * @G_SOCKET_PROTOCOL_SCTP: SCTP over IP
7794 * A protocol identifier is specified when creating a #GSocket, which is a
7795 * family/type specific identifier, where 0 means the default protocol for
7796 * the particular family/type.
7797 * This enum contains a set of commonly available and used protocols. You
7798 * can also pass any other identifiers handled by the platform in order to
7799 * use protocols not listed here.
7806 * g_action_set_state:
7807 * @action: a #GAction
7808 * @value: the new state
7810 * Request for the state of @action to be changed to @value.
7811 * The action must be stateful and @value must be of the correct type.
7812 * See g_action_get_state_type().
7813 * This call merely requests a change. The action may refuse to change
7814 * its state or may change its state to something other than @value.
7815 * See g_action_get_state_hint().
7816 * If the @value GVariant is floating, it is consumed.
7823 * g_file_replace_finish:
7824 * @file: input #GFile.
7825 * @res: a #GAsyncResult.
7826 * @error: a #GError, or %NULL
7828 * Finishes an asynchronous file replace operation started with
7829 * g_file_replace_async().
7830 * Free the returned object with g_object_unref().
7832 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
7837 * g_file_has_parent:
7838 * @file: input #GFile
7839 * @parent: the parent to check for, or %NULL
7841 * Checks if @file has a parent, and optionally, if it is @parent.
7842 * If @parent is %NULL then this function returns %TRUE if @file has any
7843 * parent at all. If @parent is non-%NULL then %TRUE is only returned
7844 * if @file is a child of @parent.
7845 * case that @parent is %NULL).
7847 * Returns: %TRUE if @file is a child of @parent (or any parent in the
7853 * g_dbus_is_supported_address:
7854 * @string: A string.
7855 * @error: Return location for error or %NULL.
7857 * Like g_dbus_is_address() but also checks if the library suppors the
7858 * transports in @string and that key/value pairs for each transport
7860 * supported by this library, %FALSE if @error is set.
7862 * Returns: %TRUE if @string is a valid D-Bus address that is
7868 * g_socket_connection_get_remote_address:
7869 * @connection: a #GSocketConnection
7870 * @error: #GError for error reporting, or %NULL to ignore.
7872 * Try to get the remote address of a socket connection.
7873 * Free the returned object with g_object_unref().
7875 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
7882 * @parent_instance: private #GParamSpec portion
7883 * @minimum: minimum value for the property specified
7884 * @maximum: maximum value for the property specified
7885 * @default_value: default value for the property specified
7887 * A #GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties.
7892 * g_dbus_message_new_method_call:
7893 * @name: A valid D-Bus name or %NULL.
7894 * @path: A valid object path.
7895 * @interface_: A valid D-Bus interface name or %NULL.
7896 * @method: A valid method name.
7898 * Creates a new #GDBusMessage for a method call.
7900 * Returns: A #GDBusMessage. Free with g_object_unref().
7906 * g_simple_async_result_new_error:
7907 * @source_object: (allow-none): a #GObject, or %NULL.
7908 * @callback: (scope async): a #GAsyncReadyCallback.
7909 * @user_data: (closure): user data passed to @callback.
7910 * @domain: a #GQuark.
7911 * @code: an error code.
7912 * @format: a string with format characters.
7913 * @...: a list of values to insert into @format.
7915 * Creates a new #GSimpleAsyncResult with a set error.
7917 * Returns: a #GSimpleAsyncResult.
7922 * g_simple_async_report_take_gerror_in_idle: (skip)
7923 * @object: (allow-none): a #GObject, or %NULL
7924 * @callback: a #GAsyncReadyCallback.
7925 * @user_data: user data passed to @callback.
7926 * @error: the #GError to report
7928 * Reports an error in an idle function. Similar to
7929 * g_simple_async_report_gerror_in_idle(), but takes over the caller's
7930 * ownership of @error, so the caller does not have to free it any more.
7937 * g_file_unmount_mountable_finish:
7938 * @file: input #GFile.
7939 * @result: a #GAsyncResult.
7940 * @error: a #GError, or %NULL
7942 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
7943 * Finish an asynchronous unmount operation that was started
7944 * with g_file_unmount_mountable().
7947 * Returns: %TRUE if the operation finished successfully. %FALSE
7948 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead.
7953 * G_TYPE_IS_DERIVED:
7954 * @type: A #GType value.
7956 * Checks if @type is derived (or in object-oriented terminology:
7957 * inherited) from another type (this holds true for all non-fundamental
7960 * Returns: %TRUE on success.
7966 * @plugin: the #GTypePlugin whose use count should be increased
7968 * The type of the @use_plugin function of #GTypePluginClass, which gets called
7969 * to increase the use count of @plugin.
7974 * G_OBJECT_GET_CLASS:
7975 * @object: a #GObject instance.
7977 * Get the class structure associated to a #GObject instance.
7979 * Returns: pointer to object class structure.
7984 * G_TYPE_IS_DERIVABLE:
7985 * @type: A #GType value.
7987 * Checks if @type is a derivable type. A derivable type can
7988 * be used as the base class of a flat (single-level) class hierarchy.
7990 * Returns: %TRUE on success.
7995 * g_app_info_can_remove_supports_type:
7996 * @appinfo: a #GAppInfo.
7998 * Checks if a supported content type can be removed from an application.
7999 * content types from a given @appinfo, %FALSE if not.
8001 * Returns: %TRUE if it is possible to remove supported
8007 * @pspec: a valid #GParamSpec instance
8009 * Cast a #GParamSpec instance into a #GParamSpecInt.
8014 * g_input_stream_read_finish:
8015 * @stream: a #GInputStream.
8016 * @result: a #GAsyncResult.
8017 * @error: a #GError location to store the error occuring, or %NULL to ignore.
8019 * Finishes an asynchronous stream read operation.
8021 * Returns: number of bytes read in, or -1 on error.
8026 * g_tls_connection_get_rehandshake_mode:
8027 * @conn: a #GTlsConnection
8029 * Gets @conn rehandshaking mode. See
8030 * g_tls_connection_set_rehandshake() for details.
8032 * Returns: @conn's rehandshaking mode
8038 * G_TYPE_RESERVED_BSE_FIRST:
8040 * First fundamental type number to create a new fundamental type id with
8041 * G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE.
8046 * g_node_first_child:
8049 * Gets the first child of a #GNode.
8050 * or has no children
8052 * Returns: the first child of @node, or %NULL if @node is %NULL
8057 * g_dbus_signal_info_ref:
8058 * @info: A #GDBusSignalInfo
8060 * If @info is statically allocated does nothing. Otherwise increases
8061 * the reference count.
8063 * Returns: The same @info.
8069 * g_main_set_poll_func:
8070 * @func: the function to call to poll all file descriptors
8072 * Sets the function to use for the handle polling of file descriptors
8073 * for the default main context.
8075 * Deprecated: 2.2: Use g_main_context_set_poll_func() again
8080 * g_loadable_icon_load:
8081 * @icon: a #GLoadableIcon.
8082 * @size: an integer.
8083 * @type: (out) (allow-none): a location to store the type of the loaded icon, %NULL to ignore.
8084 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
8085 * @error: a #GError location to store the error occuring, or %NULL to ignore.
8087 * Loads a loadable icon. For the asynchronous version of this function,
8088 * see g_loadable_icon_load_async().
8090 * Returns: (transfer full): a #GInputStream to read the icon from.
8095 * G_PRIORITY_DEFAULT_IDLE:
8097 * Use this for default priority idle functions.
8098 * In GLib this priority is used when adding idle functions with
8104 * GMountOperation:domain:
8106 * The domain to use for the mount operation.
8111 * g_socket_client_connect_to_uri_async:
8112 * @client: a #GSocketClient
8113 * @uri: a network uri
8114 * @default_port: the default port to connect to
8115 * @cancellable: (allow-none): a #GCancellable, or %NULL
8116 * @callback: (scope async): a #GAsyncReadyCallback
8117 * @user_data: (closure): user data for the callback
8119 * This is the asynchronous version of g_socket_client_connect_to_uri().
8120 * When the operation is finished @callback will be
8121 * called. You can then call g_socket_client_connect_to_uri_finish() to get
8122 * the result of the operation.
8129 * g_app_info_delete:
8130 * @appinfo: a #GAppInfo
8132 * Tries to delete a #GAppInfo.
8133 * On some platforms, there may be a difference between user-defined
8134 * #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
8135 * cannot. See g_app_info_can_delete().
8137 * Virtual: do_delete
8138 * Returns: %TRUE if @appinfo has been deleted
8144 * g_socket_client_get_tls_validation_flags:
8145 * @client: a #GSocketClient.
8147 * Gets the TLS validation flags used creating TLS connections via
8149 * Returns: the TLS validation flags
8155 * GTlsConnection:require-close-notify:
8157 * Whether or not proper TLS close notification is required.
8158 * See g_tls_connection_set_require_close_notify().
8165 * g_socket_control_message_get_level:
8166 * @message: a #GSocketControlMessage
8168 * Returns the "level" (i.e. the originating protocol) of the control message.
8169 * This is often SOL_SOCKET.
8171 * Returns: an integer describing the level
8177 * G_TYPE_VARIANT_TYPE:
8179 * The #GType for a boxed type holding a #GVariantType.
8187 * @g_type_class: the parent class
8188 * @constructor: the @constructor function is called by g_object_new () to complete the object initialization after all the construction properties are set. The first thing a @constructor implementation must do is chain up to the needed, e.g. to handle construct properties, or to implement singletons.
8189 * @set_property: the generic setter for all properties of this type. Should be overridden for every type with properties. Implementations of @set_property don't need to emit property change notification explicitly, this is handled by the type system.
8190 * @get_property: the generic getter for all properties of this type. Should be overridden for every type with properties.
8191 * @dispose: the @dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, @dispose should chain up to the @dispose method of the parent class.
8192 * @finalize: instance finalization function, should finish the finalization of the instance begun in @dispose and chain up to the @finalize method of the parent class.
8193 * @dispatch_properties_changed: emits property change notification for a bunch of properties. Overriding @dispatch_properties_changed should be rarely needed.
8194 * @notify: the class closure for the notify signal
8195 * @constructed: the @constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. @constructed implementors should chain up to the @constructed call of their parent class to allow it to complete its initialisation.
8197 * The class structure for the <structname>GObject</structname> type.
8199 * <title>Implementing singletons using a constructor</title>
8201 * static MySingleton *the_singleton = NULL;
8203 * my_singleton_constructor (GType type,
8204 * guint n_construct_params,
8205 * GObjectConstructParam *construct_params)
8208 * if (!the_singleton)
8210 * object = G_OBJECT_CLASS (parent_class)->constructor (type,
8211 * n_construct_params,
8212 * construct_params);
8213 * the_singleton = MY_SINGLETON (object);
8216 * object = g_object_ref (G_OBJECT (the_singleton));
8219 * </programlisting></example>
8224 * GRegexEvalCallback:
8225 * @match_info: 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.
8226 * @result: a #GString containing the new string
8227 * @user_data: user data passed to g_regex_replace_eval()
8229 * Specifies the type of the function passed to g_regex_replace_eval().
8230 * It is called for each occurance of the pattern in the string passed
8231 * to g_regex_replace_eval(), and it should append the replacement to
8233 * Returns: %FALSE to continue the replacement process, %TRUE to stop it
8239 * SECTION:gdbusutil:
8240 * @title: D-Bus Utilities
8241 * @short_description: Various utilities related to D-Bus.
8242 * @include: gio/gio.h
8244 * Various utility routines related to D-Bus.
8249 * g_node_insert_data_before:
8250 * @parent: the #GNode to place the new #GNode under
8251 * @sibling: the sibling #GNode to place the new #GNode before
8252 * @data: the data for the new #GNode
8254 * Inserts a new #GNode before the given sibling.
8256 * Returns: the new #GNode
8261 * g_file_info_get_attribute_boolean:
8262 * @info: a #GFileInfo.
8263 * @attribute: a file attribute key.
8265 * Gets the value of a boolean attribute. If the attribute does not
8266 * contain a boolean value, %FALSE will be returned.
8268 * Returns: the boolean value contained within the attribute.
8273 * g_mount_operation_set_domain:
8274 * @op: a #GMountOperation.
8275 * @domain: the domain to set.
8277 * Sets the mount operation's domain.
8283 * @value_init: Default initialize @values contents by poking values directly into the value->data array. The data array of the #GValue passed into this function was zero-filled with <function>memset()</function>, so no care has to be taken to free any old contents. E.g. for the implementation of a string value that may never be %NULL, the implementation might look like: |[ value->data[0].v_pointer = g_strdup (""); ]|
8284 * @value_free: Free any old contents that might be left in the data array of the passed in @value. No resources may remain allocated through the #GValue contents after this function returns. E.g. for our above string type: |[ // only free strings without a specific flag for static storage if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) g_free (value->data[0].v_pointer); ]|
8285 * @value_copy: @dest_value is a #GValue with zero-filled data section and @src_value is a properly setup #GValue of same or derived type. The purpose of this function is to copy the contents of remain valid. String type example: |[ dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); ]|
8286 * @value_peek_pointer: If the value contents fit into a pointer, such as objects or strings, return this pointer, so the caller can peek at the current contents. To extend on our above string example: |[ return value->data[0].v_pointer; ]|
8287 * @collect_format: 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: <variablelist> <varlistentry><term /><listitem><para> 'i' - Integers. passed as collect_values[].v_int. </para></listitem></varlistentry> <varlistentry><term /><listitem><para> 'l' - Longs. passed as collect_values[].v_long. </para></listitem></varlistentry> <varlistentry><term /><listitem><para> 'd' - Doubles. passed as collect_values[].v_double. </para></listitem></varlistentry> <varlistentry><term /><listitem><para> 'p' - Pointers. passed as collect_values[].v_pointer. </para></listitem></varlistentry> </variablelist> It should be noted that for variable argument list construction, ANSI C promotes every type smaller than an integer to an int, and floats to doubles. So for collection of short int or char, 'i' needs to be used, and for collection of floats 'd'.
8288 * @collect_value: The collect_value() function is responsible for converting the values collected from a variable argument list into contents suitable for storage in a GValue. This function should setup does not allow %NULL pointers, it needs to either spew an error, or do an implicit conversion by storing an empty string. The @value passed in to this function has a zero-filled data array, so just like for value_init() it is guaranteed to not contain any old contents that might need freeing. and @collect_values is an array of unions #GTypeCValue with length @n_collect_values, containing the collected values according to @collect_format. It may contain the flag %G_VALUE_NOCOPY_CONTENTS indicating, that the collected value contents may be considered "static" for the duration of the @value lifetime. Thus an extra copy of the contents stored in @collect_values is not required for assignment to @value. For our above string example, we continue with: |[ if (!collect_values[0].v_pointer) value->data[0].v_pointer = g_strdup (""); else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) { value->data[0].v_pointer = collect_values[0].v_pointer; // keep a flag for the value_free() implementation to not free this string value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS; } else value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer); return NULL; ]| It should be noted, that it is generally a bad idea to follow the #G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to reentrancy requirements and reference count assertions performed by the #GSignal code, reference counts should always be incremented for reference counted contents stored in the value->data array. To deviate from our string example for a moment, and taking a look at an exemplary implementation for collect_value() of #GObject: |[ if (collect_values[0].v_pointer) { GObject *object = G_OBJECT (collect_values[0].v_pointer); // never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types value->data[0].v_pointer = g_object_ref (object); return NULL; } else return g_strdup_printf ("Object passed as invalid NULL pointer"); } ]| The reference count for valid objects is always incremented, regardless of @collect_flags. For invalid objects, the example returns a newly allocated string without altering @value. Upon success, collect_value() needs to return %NULL. If, however, an error condition occurred, collect_value() may spew an error by returning a newly allocated non-%NULL string, giving a suitable description of the error condition. The calling code makes no assumptions about the @value contents being valid upon error returns, @value is simply thrown away without further freeing. As such, it is a good idea to not allocate #GValue contents, prior to returning an error, however, collect_values() is not obliged to return a correctly setup @value for error returns, simply because any non-%NULL return is considered a fatal condition so further program behaviour is undefined.
8289 * @lcopy_format: 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.
8290 * @lcopy_value: This function is responsible for storing the @value contents into arguments passed through a variable argument list which got collected into @collect_values according to @lcopy_format. and @collect_flags may contain %G_VALUE_NOCOPY_CONTENTS. In contrast to collect_value(), lcopy_value() is obliged to always properly support %G_VALUE_NOCOPY_CONTENTS. Similar to collect_value() the function may prematurely abort by returning a newly allocated string describing an error condition. To complete the string example: |[ gchar **string_p = collect_values[0].v_pointer; if (!string_p) return g_strdup_printf ("string location passed as NULL"); if (collect_flags & G_VALUE_NOCOPY_CONTENTS) *string_p = value->data[0].v_pointer; else *string_p = g_strdup (value->data[0].v_pointer); ]| And an illustrative version of lcopy_value() for reference-counted types: |[ GObject **object_p = collect_values[0].v_pointer; if (!object_p) return g_strdup_printf ("object location passed as NULL"); if (!value->data[0].v_pointer) *object_p = NULL; else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) // always honour *object_p = value->data[0].v_pointer; else *object_p = g_object_ref (value->data[0].v_pointer); return NULL; ]|
8292 * The #GTypeValueTable provides the functions required by the #GValue implementation,
8293 * to serve as a container for values of a type.
8299 * @struct_type: the type of the elements to allocate
8300 * @mem: the currently allocated memory
8301 * @n_structs: the number of elements to allocate
8303 * Attempts to reallocate the memory pointed to by @mem, so that it now has
8304 * space for @n_structs elements of type @struct_type, and returns %NULL on
8305 * failure. Contrast with g_renew(), which aborts the program on failure.
8306 * It returns the new address of the memory, which may have been moved.
8307 * The function returns %NULL if an overflow occurs.
8310 * Returns: a pointer to the new allocated memory, cast to a pointer to @struct_type
8315 * g_unix_mount_point_is_loopback:
8316 * @mount_point: a #GUnixMountPoint.
8318 * Checks if a unix mount point is a loopback device.
8320 * Returns: %TRUE if the mount point is a loopback. %FALSE otherwise.
8325 * g_mount_operation_get_password:
8326 * @op: a #GMountOperation.
8328 * Gets a password from the mount operation.
8330 * Returns: a string containing the password within @op.
8335 * SECTION:gfilenamecomplete:
8336 * @short_description: Filename Completer
8337 * @include: gio/gio.h
8339 * Completes partial file and directory names given a partial string by
8340 * looking in the file system for clues. Can return a list of possible
8341 * completion strings for widget implementations.
8346 * G_TYPE_PARAM_CHAR:
8348 * The #GType of #GParamSpecChar.
8353 * g_dbus_message_get_interface:
8354 * @message: A #GDBusMessage.
8356 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
8358 * Returns: The value.
8364 * g_content_types_get_registered:
8366 * Gets a list of strings containing all the registered content types
8367 * known to the system. The list and its data should be freed using
8369 * g_list_foreach (list, g_free, NULL);
8370 * g_list_free (list);
8373 * Returns: (element-type utf8) (transfer full): #GList of the registered content types
8378 * g_dbus_interface_info_ref:
8379 * @info: A #GDBusInterfaceInfo
8381 * If @info is statically allocated does nothing. Otherwise increases
8382 * the reference count.
8384 * Returns: The same @info.
8390 * GTypeClassCacheFunc:
8391 * @cache_data: data that was given to the g_type_add_class_cache_func() call
8392 * @g_class: The #GTypeClass structure which is unreferenced
8394 * A callback function which is called when the reference count of a class
8395 * drops to zero. It may use g_type_class_ref() to prevent the class from
8396 * being freed. You should not call g_type_class_unref() from a
8397 * #GTypeClassCacheFunc function to prevent infinite recursion, use
8398 * g_type_class_unref_uncached() instead.
8399 * The functions have to check the class id passed in to figure
8400 * whether they actually want to cache the class of this type, since all
8401 * classes are routed through the same #GTypeClassCacheFunc chain.
8402 * called, %FALSE to continue.
8404 * Returns: %TRUE to stop further #GTypeClassCacheFunc<!-- -->s from being
8410 * @G_TIME_TYPE_STANDARD: the time is in local standard time
8411 * @G_TIME_TYPE_DAYLIGHT: the time is in local daylight time
8412 * @G_TIME_TYPE_UNIVERSAL: the time is in UTC
8414 * Disambiguates a given time in two ways.
8415 * First, specifies if the given time is in universal or local time.
8416 * Second, if the time is in local time, specifies if it is local
8417 * standard time or local daylight time. This is important for the case
8418 * where the same local time occurs twice (during daylight savings time
8419 * transitions, for example).
8424 * g_file_info_clear_status:
8425 * @info: a #GFileInfo.
8427 * Clears the status information from @info.
8432 * g_file_eject_mountable:
8433 * @file: input #GFile.
8434 * @flags: flags affecting the operation
8435 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
8436 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
8437 * @user_data: (closure): the data to pass to callback function
8439 * Starts an asynchronous eject on a mountable.
8440 * When this operation has completed, @callback will be called with
8441 * g_file_eject_mountable_finish().
8442 * If @cancellable is not %NULL, then the operation can be cancelled by
8443 * triggering the cancellable object from another thread. If the operation
8444 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8446 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
8451 * g_dbus_message_get_member:
8452 * @message: A #GDBusMessage.
8454 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
8456 * Returns: The value.
8463 * @parent_instance: private #GParamSpec portion
8464 * @minimum: minimum value for the property specified
8465 * @maximum: maximum value for the property specified
8466 * @default_value: default value for the property specified
8468 * A #GParamSpec derived structure that contains the meta data for unsigned long integer properties.
8473 * SECTION:gfilterinputstrea:
8474 * @short_description: Filter Input Stream
8475 * @include: gio/gio.h
8477 * Base class for input stream implementations that perform some
8478 * kind of filtering operation on a base stream. Typical examples
8479 * of filtering operations are character set conversion, compression
8480 * and byte order flipping.
8486 * @object: Object to return the type id for.
8488 * Get the type id of an object.
8490 * Returns: Type id of @object.
8496 * @value: A #GValue structure.
8497 * @type: A #GType value.
8499 * Checks if @value holds (or contains) a value of @type.
8500 * This macro will also check for @value != %NULL and issue a
8501 * warning if the check fails.
8503 * Returns: %TRUE if @value holds the @type.
8508 * g_dbus_server_stop:
8509 * @server: A #GDBusServer.
8520 * Watches for changes to a file.
8525 * g_tls_connection_emit_accept_certificate:
8526 * @conn: a #GTlsConnection
8527 * @peer_cert: the peer's #GTlsCertificate
8528 * @errors: the problems with @peer_cert
8530 * Used by #GTlsConnection implementations to emit the
8531 * #GTlsConnection::accept-certificate signal.
8532 * %TRUE to accept @peer_cert
8534 * Returns: %TRUE if one of the signal handlers has returned
8540 * g_file_replace_readwrite:
8542 * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore
8543 * @make_backup: %TRUE if a backup should be created
8544 * @flags: a set of #GFileCreateFlags
8545 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
8546 * @error: return location for a #GError, or %NULL
8548 * Returns an output stream for overwriting the file in readwrite mode,
8549 * possibly creating a backup copy of the file first. If the file doesn't
8550 * exist, it will be created.
8551 * For details about the behaviour, see g_file_replace() which does the same
8552 * thing but returns an output stream only.
8553 * Note that in many non-local file cases read and write streams are not
8554 * supported, so make sure you really need to do read and write streaming,
8555 * rather than just opening for reading or writing.
8556 * Free the returned object with g_object_unref().
8558 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
8564 * g_simple_permission_new:
8565 * @allowed: %TRUE if the action is allowed
8566 * @returns: the #GSimplePermission, as a #GPermission
8568 * Creates a new #GPermission instance that represents an action that is
8569 * either always or never allowed.
8577 * @context: The active #GOptionContext
8578 * @group: The group to which the function belongs
8579 * @data: User data added to the #GOptionGroup containing the option when it was created with g_option_group_new()
8580 * @error: The #GError containing details about the parse error
8582 * The type of function to be used as callback when a parse error occurs.
8587 * g_file_query_filesystem_info_finish:
8588 * @file: input #GFile.
8589 * @res: a #GAsyncResult.
8590 * @error: a #GError.
8592 * Finishes an asynchronous filesystem info query. See
8593 * g_file_query_filesystem_info_async().
8594 * Free the returned object with g_object_unref().
8596 * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
8601 * G_TYPE_FUNDAMENTAL:
8602 * @type: A #GType value.
8604 * The fundamental type which is the ancestor of @type.
8605 * Fundamental types are types that serve as ultimate bases for the derived types,
8606 * thus they are the roots of distinct inheritance hierarchies.
8611 * GVolumeMonitor::mount-changed:
8612 * @volume_monitor: The volume monitor emitting the signal.
8613 * @mount: a #GMount that changed.
8615 * Emitted when a mount changes.
8620 * g_volume_get_identifier:
8621 * @volume: a #GVolume
8622 * @kind: the kind of identifier to return
8624 * Gets the identifier of the given kind for @volume.
8625 * See the <link linkend="volume-identifier">introduction</link>
8626 * for more information about volume identifiers.
8627 * requested identfier, or %NULL if the #GVolume
8628 * doesn't have this kind of identifier
8630 * Returns: a newly allocated string containing the
8635 * g_tcp_connection_get_graceful_disconnect:
8636 * @connection: a #GTcpConnection
8638 * Checks if graceful disconnects are used. See
8639 * g_tcp_connection_set_graceful_disconnect().
8641 * Returns: %TRUE if graceful disconnect is used on close, %FALSE otherwise
8647 * G_IS_PARAM_SPEC_OBJECT:
8648 * @pspec: a valid #GParamSpec instance
8650 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT.
8652 * Returns: %TRUE on success.
8657 * SECTION:gzdecompresso:
8658 * @short_description: Zlib decompressor
8659 * @include: gio/gio.h
8661 * #GZlibDecompressor is an implementation of #GConverter that
8662 * decompresses data compressed with zlib.
8667 * G_IS_PARAM_SPEC_VALUE_ARRAY:
8668 * @pspec: a valid #GParamSpec instance
8670 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY.
8672 * Returns: %TRUE on success.
8679 * The fundamental type from which all enumeration types are derived.
8684 * G_IS_PARAM_SPEC_BOXED:
8685 * @pspec: a valid #GParamSpec instance
8687 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED.
8689 * Returns: %TRUE on success.
8694 * g_dbus_message_get_reply_serial:
8695 * @message: A #GDBusMessage.
8697 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
8699 * Returns: The value.
8705 * g_tls_connection_get_use_system_certdb:
8706 * @conn: a #GTlsConnection
8708 * Gets whether @conn uses the system certificate database to verify
8709 * peer certificates. See g_tls_connection_set_use_system_certdb().
8711 * Returns: whether @conn uses the system certificate database
8717 * g_emblem_get_origin:
8718 * @emblem: a #GEmblem
8720 * Gets the origin of the emblem.
8722 * Returns: (transfer none): the origin of the emblem
8728 * GMemoryInputStream:
8730 * Implements #GInputStream for arbitrary memory chunks.
8735 * SECTION:gfiledescriptorbase:
8736 * @short_description: Interface for file descriptor based IO
8737 * @include: gio/gfiledescriptorbased.h
8738 * @see_also: #GInputStream, #GOutputStream
8740 * #GFileDescriptorBased is implemented by streams (implementations of
8741 * #GInputStream or #GOutputStream) that are based on file descriptors.
8742 * Note that <filename><gio/gfiledescriptorbased.h></filename> belongs to
8743 * the UNIX-specific GIO interfaces, thus you have to use the
8744 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
8751 * g_file_find_enclosing_mount_finish:
8753 * @res: a #GAsyncResult
8756 * Finishes an asynchronous find mount request.
8757 * See g_file_find_enclosing_mount_async().
8758 * Free the returned object with g_object_unref().
8760 * Returns: (transfer full): #GMount for given @file or %NULL on error.
8765 * g_inet_address_get_is_site_local:
8766 * @address: a #GInetAddress
8768 * Tests whether @address is a site-local address such as 10.0.0.1
8769 * (that is, the address identifies a host on a local network that can
8770 * not be reached directly from the Internet, but which may have
8771 * outgoing Internet connectivity via a NAT or firewall).
8773 * Returns: %TRUE if @address is a site-local address.
8781 * Allows actions to be cancelled.
8786 * g_dbus_message_set_num_unix_fds:
8787 * @message: A #GDBusMessage.
8788 * @value: The value to set.
8790 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
8799 * Implementation of the #GMount interface for Win32 systems.
8806 * The #GType for a boxed type holding a #GArray reference.
8813 * g_file_copy_async: (skip)
8814 * @source: input #GFile.
8815 * @destination: destination #GFile
8816 * @flags: set of #GFileCopyFlags
8817 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
8818 * @cancellable: optional #GCancellable object, %NULL to ignore.
8819 * @progress_callback: function to callback with progress information
8820 * @progress_callback_data: user data to pass to @progress_callback
8821 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
8822 * @user_data: the data to pass to callback function
8824 * Copies the file @source to the location specified by @destination
8825 * asynchronously. For details of the behaviour, see g_file_copy().
8826 * If @progress_callback is not %NULL, then that function that will be called
8827 * just like in g_file_copy(), however the callback will run in the main loop,
8828 * not in the thread that is doing the I/O operation.
8829 * When the operation is finished, @callback will be called. You can then call
8830 * g_file_copy_finish() to get the result of the operation.
8835 * G_FILE_ATTRIBUTE_UNIX_DEVICE:
8837 * A key in the "unix" namespace for getting the device id of the device the
8838 * file is located on (see stat() documentation). This attribute is only
8839 * available for UNIX file systems. Corresponding #GFileAttributeType is
8840 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
8845 * G_TYPE_CHECK_VALUE:
8848 * Checks if @value has been initialized to hold values
8850 * This macro should only be used in type implementations.
8852 * Returns: %TRUE on success.
8857 * G_DEFINE_POINTER_TYPE:
8858 * @TypeName: The name of the new type, in Camel case.
8859 * @type_name: The name of the new type, in lowercase, with words separated by '_'.
8861 * A convenience macro for pointer type implementations, which defines a
8862 * type_name_get_type() function registering the pointer type.
8869 * g_dbus_method_invocation_get_method_name:
8870 * @invocation: A #GDBusMethodInvocation.
8872 * Gets the name of the method that was invoked.
8874 * Returns: A string. Do not free, it is owned by @invocation.
8880 * g_io_extension_ref_class:
8881 * @extension: a #GIOExtension
8883 * Gets a reference to the class for the type that is
8884 * associated with @extension.
8886 * Returns: (transfer full): the #GTypeClass for the type of @extension
8891 * GVolumeMonitor::mount-pre-unmount:
8892 * @volume_monitor: The volume monitor emitting the signal.
8893 * @mount: a #GMount that is being unmounted.
8895 * Emitted when a mount is about to be removed.
8901 * @boxed: The boxed structure to be freed.
8903 * This function is provided by the user and should free the boxed
8909 * g_desktop_app_info_new_from_keyfile:
8910 * @key_file: an opened #GKeyFile
8912 * Creates a new #GDesktopAppInfo.
8914 * Returns: a new #GDesktopAppInfo or %NULL on error.
8920 * g_file_info_get_attribute_uint32:
8921 * @info: a #GFileInfo.
8922 * @attribute: a file attribute key.
8924 * Gets an unsigned 32-bit integer contained within the attribute. If the
8925 * attribute does not contain an unsigned 32-bit integer, or is invalid,
8926 * 0 will be returned.
8928 * Returns: an unsigned 32-bit integer from the attribute.
8935 * A lowlevel network socket object.
8942 * g_dbus_server_is_active:
8943 * @server: A #GDBusServer.
8945 * Gets whether @server is active.
8947 * Returns: %TRUE if server is active, %FALSE otherwise.
8953 * g_application_set_inactivity_timeout:
8954 * @application: a #GApplication
8955 * @inactivity_timeout: the timeout, in milliseconds
8957 * Sets the current inactivity timeout for the application.
8958 * This is the amount of time (in milliseconds) after the last call to
8959 * g_application_release() before the application stops running.
8960 * This call has no side effects of its own. The value set here is only
8961 * used for next time g_application_release() drops the use count to
8962 * zero. Any timeouts currently in progress are not impacted.
8964 * Returns: the timeout, in milliseconds
8972 * This signal is emitted when the #GVolume have been removed. If
8973 * the recipient is holding references to the object they should
8974 * release them so the object can be finalized.
8979 * GDesktopAppLaunchCallback:
8980 * @appinfo: a #GDesktopAppInfo
8981 * @pid: Process identifier
8982 * @user_data: User data
8984 * During invocation, g_desktop_app_info_launch_uris_as_manager() may
8985 * create one or more child processes. This callback is invoked once
8986 * for each, providing the process ID.
8991 * g_settings_set_flags:
8992 * @settings: a #GSettings object
8993 * @key: a key, within @settings
8994 * @value: a flags value
8995 * @returns: %TRUE, if the set succeeds
8997 * Looks up the flags type nicks for the bits specified by @value, puts
8998 * them in an array of strings and writes the array to @key, withing
8999 * It is a programmer error to give a @key that isn't contained in the
9000 * schema for @settings or is not marked as a flags type, or for @value
9001 * to contain any bits that are not value for the named type.
9002 * After performing the write, accessing @key directly with
9003 * g_settings_get_strv() will return an array of 'nicks'; one for each
9009 * g_drive_has_volumes:
9010 * @drive: a #GDrive.
9012 * Check if @drive has any mountable volumes.
9014 * Returns: %TRUE if the @drive contains volumes, %FALSE otherwise.
9019 * g_app_info_get_description:
9020 * @appinfo: a #GAppInfo.
9022 * Gets a human-readable description of an installed application.
9023 * application @appinfo, or %NULL if none.
9025 * Returns: a string containing a description of the
9030 * g_input_stream_close_async:
9031 * @stream: A #GInputStream.
9032 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
9033 * @cancellable: (allow-none): optional cancellable object
9034 * @callback: (scope async): callback to call when the request is satisfied
9035 * @user_data: (closure): the data to pass to callback function
9037 * Requests an asynchronous closes of the stream, releasing resources related to it.
9038 * When the operation is finished @callback will be called.
9039 * You can then call g_input_stream_close_finish() to get the result of the
9041 * For behaviour details see g_input_stream_close().
9042 * The asyncronous methods have a default fallback that uses threads to implement
9043 * asynchronicity, so they are optional for inheriting classes. However, if you
9044 * override one you must override all.
9049 * g_file_descriptor_based_get_fd:
9050 * @fd_based: a #GFileDescriptorBased.
9052 * Gets the underlying file descriptor.
9054 * Returns: The file descriptor
9061 * @file: input #GFile.
9062 * @flags: a set of #GFileCreateFlags.
9063 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
9064 * @error: a #GError, or %NULL
9066 * Gets an output stream for appending data to the file. If
9067 * the file doesn't already exist it is created.
9068 * By default files created are generally readable by everyone,
9069 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
9070 * will be made readable only to the current user, to the level that
9071 * is supported on the target filesystem.
9072 * If @cancellable is not %NULL, then the operation can be cancelled by
9073 * triggering the cancellable object from another thread. If the operation
9074 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9075 * Some file systems don't allow all file names, and may
9076 * return an %G_IO_ERROR_INVALID_FILENAME error.
9077 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
9078 * returned. Other errors are possible too, and depend on what kind of
9079 * filesystem the file is on.
9080 * Free the returned object with g_object_unref().
9082 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
9087 * g_data_input_stream_read_until_finish:
9088 * @stream: a given #GDataInputStream.
9089 * @result: the #GAsyncResult that was provided to the callback.
9090 * @length: (out): a #gsize to get the length of the data read in.
9091 * @error: #GError for error reporting.
9093 * Finish an asynchronous call started by
9094 * g_data_input_stream_read_until_async().
9095 * before encountering any of the stop characters. Set @length to
9096 * a #gsize to get the length of the string. This function will
9097 * return %NULL on an error.
9100 * Returns: (transfer full): a string with the data that was read
9107 * A numerical value which represents the unique identifier of a registered
9115 * Opaque drive object.
9120 * G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP:
9122 * A key in the "standard" namespace for checking if a file is a backup file.
9123 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
9128 * g_proxy_address_get_protocol:
9129 * @proxy: a #GProxyAddress
9131 * Gets @proxy's protocol.
9133 * Returns: the @proxy's protocol
9139 * g_input_stream_set_pending:
9140 * @stream: input stream
9141 * @error: a #GError location to store the error occuring, or %NULL to ignore.
9143 * Sets @stream to have actions pending. If the pending flag is
9144 * already set or @stream is closed, it will return %FALSE and set
9146 * Returns: %TRUE if pending was previously unset and is now set.
9153 * Checks if any events are pending for the default #GMainContext
9154 * (i.e. ready to be processed).
9156 * Returns: %TRUE if any events are pending.
9157 * Deprected: 2.2: Use g_main_context_pending() instead.
9164 * The <structname>GIConv</structname> struct wraps an
9165 * iconv() conversion descriptor. It contains private data
9166 * and should only be accessed using the following functions.
9171 * g_application_command_line_get_is_remote:
9172 * @cmdline: a #GApplicationCommandLine
9174 * Determines if @cmdline represents a remote invocation.
9176 * Returns: %TRUE if the invocation was remote
9182 * g_dbus_error_new_for_dbus_error:
9183 * @dbus_error_name: D-Bus error name.
9184 * @dbus_error_message: D-Bus error message.
9186 * Creates a #GError based on the contents of @dbus_error_name and
9187 * Errors registered with g_dbus_error_register_error() will be looked
9188 * up using @dbus_error_name and if a match is found, the error domain
9189 * and code is used. Applications can use g_dbus_error_get_remote_error()
9190 * to recover @dbus_error_name.
9191 * If a match against a registered error is not found and the D-Bus
9192 * error name is in a form as returned by g_dbus_error_encode_gerror()
9193 * the error domain and code encoded in the name is used to
9194 * create the #GError. Also, @dbus_error_name is added to the error message
9195 * such that it can be recovered with g_dbus_error_get_remote_error().
9196 * Otherwise, a #GError with the error code %G_IO_ERROR_DBUS_ERROR
9197 * in the #G_IO_ERROR error domain is returned. Also, @dbus_error_name is
9198 * added to the error message such that it can be recovered with
9199 * g_dbus_error_get_remote_error().
9200 * In all three cases, @dbus_error_name can always be recovered from the
9201 * returned #GError using the g_dbus_error_get_remote_error() function
9202 * (unless g_dbus_error_strip_remote_error() hasn't been used on the returned error).
9203 * This function is typically only used in object mappings to prepare
9204 * #GError instances for applications. Regular applications should not use
9207 * Returns: An allocated #GError. Free with g_error_free().
9213 * GTlsCertificate:certificate-pem:
9215 * The PEM (ASCII) encoded representation of the certificate's
9216 * public key. This property and the #GTlsCertificate:certificate
9217 * property represent the same data, just in different forms.
9225 * @struct_type: the type of the elements to allocate
9226 * @n_structs: the number of elements to allocate
9228 * Attempts to allocate @n_structs elements of type @struct_type, and returns
9229 * %NULL on failure. Contrast with g_new(), which aborts the program on failure.
9230 * The returned pointer is cast to a pointer to the given type.
9231 * The function returns %NULL when @n_structs is 0 of if an overflow occurs.
9234 * Returns: a pointer to the allocated memory, cast to a pointer to @struct_type
9239 * GSignalCMarshaller:
9241 * This is the signature of marshaller functions, required to marshall
9242 * arrays of parameter values to signal emissions into C language callback
9243 * invocations. It is merely an alias to #GClosureMarshal since the #GClosure
9244 * mechanism takes over responsibility of actual function invocation for the
9250 * G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT:
9252 * A key in the "trash" namespace. When requested against
9253 * "trash:///" returns the number of (toplevel) items in the trash folder.
9254 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
9259 * g_dbus_proxy_get_cached_property_names:
9260 * @proxy: A #GDBusProxy.
9262 * Gets the names of all cached properties on @proxy.
9263 * no cached properties. Free the returned array with g_strfreev().
9265 * Returns: A %NULL-terminated array of strings or %NULL if @proxy has
9271 * G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE:
9273 * A key in the "access" namespace for getting write privileges.
9274 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
9275 * This attribute will be %TRUE if the user is able to write to the file.
9280 * GZlibDecompressor:
9282 * Zlib decompression
9287 * GDrive::eject-button:
9288 * @drive: a #GDrive.
9290 * Emitted when the physical eject button (if any) of a drive has
9296 * g_application_set_flags:
9297 * @application: a #GApplication
9298 * @flags: the flags for @application
9300 * Sets the flags for @application.
9301 * The flags can only be modified if @application has not yet been
9303 * See #GApplicationFlags.
9310 * GSettings::changed:
9311 * @settings: the object on which the signal was emitted
9312 * @key: the name of the key that changed
9314 * The "changed" signal is emitted when a key has potentially changed.
9315 * You should call one of the g_settings_get() calls to check the new
9317 * This signal supports detailed connections. You can connect to the
9318 * detailed signal "changed::x" in order to only receive callbacks
9319 * when key "x" changes.
9325 * @file: input #GFile.
9326 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
9327 * @error: a #GError, or %NULL
9329 * Deletes a file. If the @file is a directory, it will only be deleted if it
9331 * If @cancellable is not %NULL, then the operation can be cancelled by
9332 * triggering the cancellable object from another thread. If the operation
9333 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
9335 * Virtual: delete_file
9336 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
9341 * GSettings:context:
9343 * The name of the context that the settings are stored in.
9350 * Error domain for regular expressions. Errors in this domain will be
9351 * from the #GRegexError enumeration. See #GError for information on
9359 * GDBusAnnotationInfo:
9360 * @ref_count: The reference count or -1 if statically allocated.
9361 * @key: The name of the annotation, e.g. "org.freedesktop.DBus.Deprecated".
9362 * @value: The value of the annotation.
9363 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
9365 * Information about an annotation.
9372 * g_output_stream_is_closing:
9373 * @stream: a #GOutputStream.
9375 * Checks if an output stream is being closed. This can be
9376 * used inside e.g. a flush implementation to see if the
9377 * flush (or other i/o operation) is called from within
9378 * the closing operation.
9380 * Returns: %TRUE if @stream is being closed. %FALSE otherwise.
9386 * g_data_input_stream_read_line_async:
9387 * @stream: a given #GDataInputStream.
9388 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
9389 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
9390 * @callback: (scope async): callback to call when the request is satisfied.
9391 * @user_data: (closure): the data to pass to callback function.
9393 * The asynchronous version of g_data_input_stream_read_line(). It is
9394 * an error to have two outstanding calls to this function.
9395 * When the operation is finished, @callback will be called. You
9396 * can then call g_data_input_stream_read_line_finish() to get
9397 * the result of the operation.
9404 * g_output_stream_write_finish:
9405 * @stream: a #GOutputStream.
9406 * @result: a #GAsyncResult.
9407 * @error: a #GError location to store the error occuring, or %NULL to ignore.
9409 * Finishes a stream write operation.
9411 * Returns: a #gssize containing the number of bytes written to the stream.
9416 * g_file_create_readwrite_async:
9417 * @file: input #GFile
9418 * @flags: a set of #GFileCreateFlags
9419 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request
9420 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
9421 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
9422 * @user_data: (closure): the data to pass to callback function
9424 * Asynchronously creates a new file and returns a stream for reading and
9425 * writing to it. The file must not already exist.
9426 * For more details, see g_file_create_readwrite() which is
9427 * the synchronous version of this call.
9428 * When the operation is finished, @callback will be called. You can then
9429 * call g_file_create_readwrite_finish() to get the result of the operation.
9436 * GDBusAuthObserver::authorize-authenticated-peer:
9437 * @observer: The #GDBusAuthObserver emitting the signal.
9438 * @stream: A #GIOStream for the #GDBusConnection.
9439 * @credentials: Credentials received from the peer or %NULL.
9441 * Emitted to check if a peer that is successfully authenticated
9444 * Returns: %TRUE if the peer is authorized, %FALSE if not.
9451 * @ufds: an array of #GPollFD elements
9452 * @nfsd: the number of elements in @ufds
9453 * @timeout_: the maximum time to wait for an event of the file descriptors. A negative value indicates an infinite timeout.
9455 * Specifies the type of function passed to g_main_context_set_poll_func().
9456 * The semantics of the function should match those of the poll() system call.
9457 * reported, or -1 if an error occurred.
9459 * Returns: the number of #GPollFD elements which have events or errors
9464 * GSimpleAction::activate:
9465 * @simple: the #GSimpleAction
9466 * @parameter: (allow-none): the parameter to the activation
9468 * Indicates that the action was just activated.
9469 * an incorrect type was given, no signal will be emitted.
9476 * g_cancellable_source_new: (skip)
9477 * @cancellable: a #GCancellable, or %NULL
9479 * Creates a source that triggers if @cancellable is cancelled and
9480 * calls its callback of type #GCancellableSourceFunc. This is
9481 * primarily useful for attaching to another (non-cancellable) source
9482 * with g_source_add_child_source() to add cancellability to it.
9483 * For convenience, you can call this with a %NULL #GCancellable,
9484 * in which case the source will never trigger.
9486 * Returns: (transfer full): the new #GSource.
9492 * g_data_input_stream_read_byte:
9493 * @stream: a given #GDataInputStream.
9494 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
9495 * @error: #GError for error reporting.
9497 * Reads an unsigned 8-bit/1-byte value from @stream.
9498 * if an error occurred.
9500 * Returns: an unsigned 8-bit/1-byte value read from the @stream or %0
9507 * Seek object for streaming operations.
9514 * g_socket_client_connect_to_host_finish:
9515 * @client: a #GSocketClient.
9516 * @result: a #GAsyncResult.
9517 * @error: a #GError location to store the error occuring, or %NULL to ignore.
9519 * Finishes an async connect operation. See g_socket_client_connect_to_host_async()
9521 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
9527 * G_FILE_ATTRIBUTE_TIME_CREATED:
9529 * A key in the "time" namespace for getting the time the file was created.
9530 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
9531 * and contains the UNIX time since the file was created.
9532 * This corresponds to the NTFS ctime.
9537 * GMountOperation::ask-question:
9538 * @op: a #GMountOperation asking a question.
9539 * @message: string containing a message to display to the user.
9540 * @choices: an array of strings for each possible choice.
9542 * Emitted when asking the user a question and gives a list of
9543 * choices for the user to choose from.
9544 * If the message contains a line break, the first line should be
9545 * presented as a heading. For example, it may be used as the
9546 * primary text in a #GtkMessageDialog.
9551 * G_IS_INITIALLY_UNOWNED_CLASS:
9552 * @class: a #GInitiallyUnownedClass
9554 * Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
9555 * %G_TYPE_INITIALLY_UNOWNED or derived.
9560 * GUnixOutputStream:
9562 * Implements #GOutputStream for outputting to selectable unix file descriptors
9567 * SECTION:extensionpoint:
9568 * @short_description: Extension Points
9570 * @see_also: <link linkend="extending-gio">Extending GIO</link>
9572 * #GIOExtensionPoint provides a mechanism for modules to extend the
9573 * functionality of the library or application that loaded it in an
9574 * organized fashion.
9575 * An extension point is identified by a name, and it may optionally
9576 * require that any implementation must by of a certain type (or derived
9577 * thereof). Use g_io_extension_point_register() to register an
9578 * extension point, and g_io_extension_point_set_required_type() to
9579 * set a required type.
9580 * A module can implement an extension point by specifying the #GType
9581 * that implements the functionality. Additionally, each implementation
9582 * of an extension point has a name, and a priority. Use
9583 * g_io_extension_point_implement() to implement an extension point.
9585 * GIOExtensionPoint *ep;
9586 * /* Register an extension point */
9587 * ep = g_io_extension_point_register ("my-extension-point");
9588 * g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE);
9591 * /* Implement an extension point */
9592 * G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE);
9593 * g_io_extension_point_implement ("my-extension-point",
9594 * my_example_impl_get_type (),
9598 * It is up to the code that registered the extension point how
9599 * it uses the implementations that have been associated with it.
9600 * Depending on the use case, it may use all implementations, or
9601 * only the one with the highest priority, or pick a specific
9603 * To avoid opening all modules just to find out what extension
9604 * points they implement, GIO makes use of a caching mechanism,
9605 * see <link linkend="gio-querymodules">gio-querymodules</link>.
9606 * You are expected to run this command after installing a
9612 * g_pollable_output_stream_write_nonblocking:
9613 * @stream: a #GPollableOutputStream
9614 * @buffer: (array length=size) (element-type guint8): a buffer to write data from
9615 * @size: the number of bytes you want to write
9616 * @cancellable: (allow-none): a #GCancellable, or %NULL
9617 * @error: #GError for error reporting, or %NULL to ignore.
9619 * Attempts to write up to @size bytes from @buffer to @stream, as
9620 * with g_output_stream_write(). If @stream is not currently writable,
9621 * this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can
9622 * use g_pollable_output_stream_create_source() to create a #GSource
9623 * that will be triggered when @stream is writable.
9624 * Note that since this method never blocks, you cannot actually
9625 * use @cancellable to cancel it. However, it will return an error
9626 * if @cancellable has already been cancelled when you call, which
9627 * may happen if you call this method after a source triggers due
9628 * to having been cancelled.
9629 * %G_IO_ERROR_WOULD_BLOCK).
9631 * Virtual: write_nonblocking
9632 * Returns: the number of bytes written, or -1 on error (including
9637 * g_output_stream_write:
9638 * @stream: a #GOutputStream.
9639 * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write.
9640 * @count: the number of bytes to write
9641 * @cancellable: (allow-none): optional cancellable object
9642 * @error: location to store the error occuring, or %NULL to ignore
9644 * Tries to write @count bytes from @buffer into the stream. Will block
9645 * during the operation.
9646 * If count is 0, returns 0 and does nothing. A value of @count
9647 * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
9648 * On success, the number of bytes written to the stream is returned.
9649 * It is not an error if this is not the same as the requested size, as it
9650 * can happen e.g. on a partial I/O error, or if there is not enough
9651 * storage in the stream. All writes block until at least one byte
9652 * is written or an error occurs; 0 is never returned (unless
9653 * If @cancellable is not NULL, then the operation can be cancelled by
9654 * triggering the cancellable object from another thread. If the operation
9655 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
9656 * operation was partially finished when the operation was cancelled the
9657 * partial result will be returned, without an error.
9658 * On error -1 is returned and @error is set accordingly.
9660 * Returns: Number of bytes written, or -1 on error
9666 * @loop: a #GMainLoop
9668 * Frees the memory allocated for the #GMainLoop.
9670 * Deprecated: 2.2: Use g_main_loop_unref() instead
9675 * g_dbus_connection_new:
9676 * @stream: A #GIOStream.
9677 * @guid: The GUID to use if a authenticating as a server or %NULL.
9678 * @flags: Flags describing how to make the connection.
9679 * @observer: A #GDBusAuthObserver or %NULL.
9680 * @cancellable: A #GCancellable or %NULL.
9681 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
9682 * @user_data: The data to pass to @callback.
9684 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
9685 * with the end represented by @stream.
9686 * If @observer is not %NULL it may be used to control the
9687 * authentication process.
9688 * When the operation is finished, @callback will be invoked. You can
9689 * then call g_dbus_connection_new_finish() to get the result of the
9691 * This is a asynchronous failable constructor. See
9692 * g_dbus_connection_new_sync() for the synchronous
9701 * @G_PASSWORD_SAVE_NEVER: never save a password.
9702 * @G_PASSWORD_SAVE_FOR_SESSION: save a password for the session.
9703 * @G_PASSWORD_SAVE_PERMANENTLY: save a password permanently.
9705 * #GPasswordSave is used to indicate the lifespan of a saved password.
9706 * #Gvfs stores passwords in the Gnome keyring when this flag allows it
9707 * to, and later retrieves it again from there.
9712 * G_FILE_ATTRIBUTE_TIME_CREATED_USEC:
9714 * A key in the "time" namespace for getting the microseconds of the time
9715 * the file was created. This should be used in conjunction with
9716 * #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is
9717 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
9722 * G_BOOKMARK_FILE_ERROR:
9724 * Error domain for bookmark file parsing.
9725 * Errors in this domain will be from the #GBookmarkFileError
9726 * enumeration. See #GError for information on error domains.
9731 * g_unix_credentials_message_get_credentials:
9732 * @message: A #GUnixCredentialsMessage.
9734 * Gets the credentials stored in @message.
9736 * Returns: (transfer none): A #GCredentials instance. Do not free, it is owned by @message.
9742 * SECTION:gfileenumerato:
9743 * @short_description: Enumerated Files Routines
9744 * @include: gio/gio.h
9746 * #GFileEnumerator allows you to operate on a set of #GFile<!-- -->s,
9747 * returning a #GFileInfo structure for each file enumerated (e.g.
9748 * g_file_enumerate_children() will return a #GFileEnumerator for each
9749 * of the children within a directory).
9750 * To get the next file's information from a #GFileEnumerator, use
9751 * g_file_enumerator_next_file() or its asynchronous version,
9752 * g_file_enumerator_next_files_async(). Note that the asynchronous
9753 * version will return a list of #GFileInfo<!---->s, whereas the
9754 * synchronous will only return the next file in the enumerator.
9755 * To close a #GFileEnumerator, use g_file_enumerator_close(), or
9756 * its asynchronous version, g_file_enumerator_close_async(). Once
9757 * a #GFileEnumerator is closed, no further actions may be performed
9758 * on it, and it should be freed with g_object_unref().
9763 * GThemedIcon:use-default-fallbacks:
9765 * Whether to use the default fallbacks found by shortening the icon name
9766 * at '-' characters. If the "names" array has more than one element,
9767 * ignores any past the first.
9768 * For example, if the icon name was "gnome-dev-cdrom-audio", the array
9772 * "gnome-dev-cdrom-audio",
9773 * "gnome-dev-cdrom",
9783 * g_mount_remount_finish:
9784 * @mount: a #GMount.
9785 * @result: a #GAsyncResult.
9786 * @error: a #GError location to store the error occuring, or %NULL to ignore.
9788 * Finishes remounting a mount. If any errors occurred during the operation,
9790 * Returns: %TRUE if the mount was successfully remounted. %FALSE otherwise.
9797 * Ensures that all pending operations for the given are complete for
9798 * the default backend.
9799 * Writes made to a #GSettings are handled asynchronously. For this
9800 * reason, it is very unlikely that the changes have it to disk by the
9801 * time g_settings_set() returns.
9802 * This call will block until all of the writes have made it to the
9803 * backend. Since the mainloop is not running, no change notifications
9804 * will be dispatched during this call (but some may be queued by the
9805 * time the call is done).
9812 * A #GSocketConnectable for resolving a hostname and connecting to
9818 * G_VARIANT_TYPE_INT64:
9820 * The type of an integer value that can range from
9821 * -9223372036854775808 to 9223372036854775807.
9826 * g_socket_address_enumerator_next_async:
9827 * @enumerator: a #GSocketAddressEnumerator
9828 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
9829 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
9830 * @user_data: (closure): the data to pass to callback function
9832 * Asynchronously retrieves the next #GSocketAddress from @enumerator
9833 * and then calls @callback, which must call
9834 * g_socket_address_enumerator_next_finish() to get the result.
9839 * g_settings_get_strv:
9840 * @settings: a #GSettings object
9841 * @key: the key to get the value for
9842 * @returns: (array zero-terminated=1) (transfer full): the value that is
9844 * A convenience variant of g_settings_get() for string arrays.
9845 * It is a programmer error to give a @key that isn't specified as
9846 * having an array of strings type in the schema for @settings.
9847 * stored at @key in @settings.
9854 * g_unix_output_stream_set_close_fd:
9855 * @stream: a #GUnixOutputStream
9856 * @close_fd: %TRUE to close the file descriptor when done
9858 * Sets whether the file descriptor of @stream shall be closed
9859 * when the stream is closed.
9866 * g_tls_certificate_new_from_pem:
9867 * @data: PEM-encoded certificate data
9868 * @length: the length of @data, or -1 if it's 0-terminated.
9869 * @error: #GError for error reporting, or %NULL to ignore.
9871 * Creates a new #GTlsCertificate from the PEM-encoded data in @data.
9872 * If @data includes both a certificate and a private key, then the
9873 * returned certificate will include the private key data as well.
9874 * If @data includes multiple certificates, only the first one will be
9877 * Returns: the new certificate, or %NULL if @data is invalid
9883 * g_dbus_message_set_interface:
9884 * @message: A #GDBusMessage.
9885 * @value: The value to set.
9887 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
9894 * g_charset_converter_new:
9895 * @to_charset: destination charset
9896 * @from_charset: source charset
9897 * @error: #GError for error reporting, or %NULL to ignore.
9899 * Creates a new #GCharsetConverter.
9901 * Returns: a new #GCharsetConverter or %NULL on error.
9908 * @parent_instance: private #GParamSpec portion
9909 * @minimum: minimum value for the property specified
9910 * @maximum: maximum value for the property specified
9911 * @default_value: default value for the property specified
9913 * A #GParamSpec derived structure that contains the meta data for unsigned integer properties.
9918 * g_simple_async_result_set_op_res_gboolean:
9919 * @simple: a #GSimpleAsyncResult.
9920 * @op_res: a #gboolean.
9922 * Sets the operation result to a boolean within the asynchronous result.
9927 * G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL:
9929 * A key in the "standard" namespace for checking if a file is virtual.
9930 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
9935 * g_unix_fd_list_get:
9936 * @list: a #GUnixFDList
9937 * @index_: the index into the list
9938 * @error: a #GError pointer
9940 * Gets a file descriptor out of @list.
9941 * programmer error for @index_ to be out of range; see
9942 * g_unix_fd_list_get_length().
9943 * The file descriptor is duplicated using dup() and set as
9944 * close-on-exec before being returned. You must call close() on it
9945 * when you are done.
9946 * A possible cause of failure is exceeding the per-process or
9947 * system-wide file descriptor limit.
9949 * Returns: the file descriptor, or -1 in case of error
9955 * G_TYPE_DBUS_PROPERTY_INFO:
9957 * The #GType for a boxed type holding a #GDBusPropertyInfo.
9966 * The #GType for #GDate.
9972 * @G_EMBLEM_ORIGIN_UNKNOWN: Emblem of unknown origin
9973 * @G_EMBLEM_ORIGIN_DEVICE: Emblem adds device-specific information
9974 * @G_EMBLEM_ORIGIN_LIVEMETADATA: Emblem depicts live metadata, such as "readonly"
9975 * @G_EMBLEM_ORIGIN_TAG: Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)
9977 * GEmblemOrigin is used to add information about the origin of the emblem
9985 * GAppLaunchContext:
9987 * Integrating the launch with the launching application. This is used to
9988 * handle for instance startup notification and launching the new application
9989 * on the same screen as the launching window.
9994 * G_FILE_ATTRIBUTE_THUMBNAILING_FAILED:
9996 * A key in the "thumbnail" namespace for checking if thumbnailing failed.
9997 * This attribute is %TRUE if thumbnailing failed. Corresponding
9998 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
10003 * G_FILE_ATTRIBUTE_ETAG_VALUE:
10005 * A key in the "etag" namespace for getting the value of the file's
10006 * entity tag. Corresponding #GFileAttributeType is
10007 * %G_FILE_ATTRIBUTE_TYPE_STRING.
10012 * GFilesystemPreviewType:
10013 * @G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS: Only preview files if user has explicitly requested it.
10014 * @G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL: Preview files if user has requested preview of "local" files.
10015 * @G_FILESYSTEM_PREVIEW_TYPE_NEVER: Never preview files.
10017 * Indicates a hint from the file system whether files should be
10018 * previewed in a file manager. Returned as the value of the key
10019 * #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW.
10024 * g_simple_action_new:
10025 * @name: the name of the action
10026 * @parameter_type: (allow-none): the type of parameter to the activate function
10028 * Creates a new action.
10029 * The created action is stateless. See g_simple_action_new_stateful().
10031 * Returns: a new #GSimpleAction
10037 * g_inet_address_get_is_link_local:
10038 * @address: a #GInetAddress
10040 * Tests whether @address is a link-local address (that is, if it
10041 * identifies a host on a local network that is not connected to the
10044 * Returns: %TRUE if @address is a link-local address.
10050 * g_signal_connect_after:
10051 * @instance: the instance to connect to.
10052 * @detailed_signal: a string of the form "signal-name::detail".
10053 * @c_handler: the #GCallback to connect.
10054 * @data: data to pass to @c_handler calls.
10056 * Connects a #GCallback function to a signal for a particular object.
10057 * The handler will be called after the default handler of the signal.
10059 * Returns: the handler id
10064 * g_drive_has_media:
10065 * @drive: a #GDrive.
10067 * Checks if the @drive has media. Note that the OS may not be polling
10068 * the drive for media changes; see g_drive_is_media_check_automatic()
10069 * for more details.
10071 * Returns: %TRUE if @drive has media, %FALSE otherwise.
10076 * g_simple_async_result_set_op_res_gssize:
10077 * @simple: a #GSimpleAsyncResult.
10078 * @op_res: a #gssize.
10080 * Sets the operation result within the asynchronous result to
10081 * the given @op_res.
10086 * g_loadable_icon_load_finish:
10087 * @icon: a #GLoadableIcon.
10088 * @res: a #GAsyncResult.
10089 * @type: a location to store the type of the loaded icon, %NULL to ignore.
10090 * @error: a #GError location to store the error occuring, or %NULL to ignore.
10092 * Finishes an asynchronous icon load started in g_loadable_icon_load_async().
10094 * Returns: (transfer full): a #GInputStream to read the icon from.
10100 * @long_name: The long name of an option can be used to specify it in a commandline as --<replaceable>long_name</replaceable>. 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 --<replaceable>groupname</replaceable>-<replaceable>long_name</replaceable>.
10101 * @short_name: If an option has a short name, it can be specified -<replaceable>short_name</replaceable> in a commandline. @short_name must be a printable ASCII character different from '-', or zero if the option has no short name.
10102 * @flags: Flags from #GOptionFlags.
10103 * @arg: The type of the option, as a #GOptionArg.
10104 * @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 the location depends on the @arg type: <variablelist> <varlistentry> <term>%G_OPTION_ARG_NONE</term> <listitem><para>%gboolean</para></listitem> </varlistentry> <varlistentry> <term>%G_OPTION_ARG_STRING</term> <listitem><para>%gchar*</para></listitem> </varlistentry> <varlistentry> <term>%G_OPTION_ARG_INT</term> <listitem><para>%gint</para></listitem> </varlistentry> <varlistentry> <term>%G_OPTION_ARG_FILENAME</term> <listitem><para>%gchar*</para></listitem> </varlistentry> <varlistentry> <term>%G_OPTION_ARG_STRING_ARRAY</term> <listitem><para>%gchar**</para></listitem> </varlistentry> <varlistentry> <term>%G_OPTION_ARG_FILENAME_ARRAY</term> <listitem><para>%gchar**</para></listitem> </varlistentry> <varlistentry> <term>%G_OPTION_ARG_DOUBLE</term> <listitem><para>%gdouble</para></listitem> </varlistentry> </variablelist> If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME the location will contain a newly allocated string if the option was given. That string needs to be freed by the callee using g_free(). Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().
10105 * @description: the description for the option in <option>--help</option> output. The @description is translated using the @translate_func of the group, see g_option_group_set_translation_domain().
10106 * @arg_description: The placeholder to use for the extra argument parsed by the option in <option>--help</option> output. The @arg_description is translated using the @translate_func of the group, see g_option_group_set_translation_domain().
10108 * A <structname>GOptionEntry</structname> defines a single option.
10109 * To have an effect, they must be added to a #GOptionGroup with
10110 * g_option_context_add_main_entries() or g_option_group_add_entries().
10115 * g_resolver_get_default:
10117 * Gets the default #GResolver. You should unref it when you are done
10118 * with it. #GResolver may use its reference count as a hint about how
10119 * many threads/processes, etc it should allocate for concurrent DNS
10122 * Returns: (transfer full): the default #GResolver.
10128 * g_application_command_line_print:
10129 * @cmdline: a #GApplicationCommandLine
10130 * @format: a printf-style format string
10131 * @...: arguments, as per @format
10133 * Formats a message and prints it using the stdout print handler in the
10134 * invoking process.
10135 * If @cmdline is a local invocation then this is exactly equivalent to
10136 * g_print(). If @cmdline is remote then this is equivalent to calling
10137 * g_print() in the invoking process.
10144 * G_PARAM_SPEC_CHAR:
10145 * @pspec: a valid #GParamSpec instance
10147 * Cast a #GParamSpec instance into a #GParamSpecChar.
10152 * g_file_info_has_attribute:
10153 * @info: a #GFileInfo.
10154 * @attribute: a file attribute key.
10156 * Checks if a file info structure has an attribute named @attribute.
10157 * %FALSE otherwise.
10159 * Returns: %TRUE if @Ginfo has an attribute named @attribute,
10164 * g_drive_get_volumes:
10165 * @drive: a #GDrive.
10167 * Get a list of mountable volumes for @drive.
10168 * The returned list should be freed with g_list_free(), after
10169 * its elements have been unreffed with g_object_unref().
10171 * Returns: (element-type GVolume) (transfer full): #GList containing any #GVolume objects on the given @drive.
10176 * g_dbus_connection_start_message_processing:
10177 * @connection: A #GDBusConnection.
10179 * If @connection was created with
10180 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
10181 * starts processing messages. Does nothing on if @connection wasn't
10182 * created with this flag or if the method has already been called.
10189 * g_desktop_app_info_set_desktop_env:
10190 * @desktop_env: a string specifying what desktop this is
10192 * Sets the name of the desktop that the application is running in.
10193 * This is used by g_app_info_should_show() to evaluate the
10194 * <literal>OnlyShowIn</literal> and <literal>NotShowIn</literal>
10195 * desktop entry fields.
10196 * The <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Desktop
10197 * Menu specification</ulink> recognizes the following:
10199 * <member>GNOME</member>
10200 * <member>KDE</member>
10201 * <member>ROX</member>
10202 * <member>XFCE</member>
10203 * <member>Old</member>
10205 * Should be called only once; subsequent calls are ignored.
10212 * An opaque structure used to hold different types of values.
10213 * to functions within a #GTypeValueTable structure, or implementations of
10214 * the g_value_*() API. That is, code portions which implement new fundamental
10216 * #GValue users can not make any assumptions about how data is stored
10217 * within the 2 element @data union, and the @g_type member should
10218 * only be accessed through the G_VALUE_TYPE() macro.
10220 * The data within the structure has protected scope: it is accessible only
10225 * GFileCreateFlags:
10226 * @G_FILE_CREATE_NONE: No flags set.
10227 * @G_FILE_CREATE_PRIVATE: Create a file that can only be accessed by the current user.
10228 * @G_FILE_CREATE_REPLACE_DESTINATION: Replace the destination as if it didn't exist before. Don't try to keep any old permissions, replace instead of following links. This is generally useful if you're doing a "copy over" rather than a "save new version of" replace operation. You can think of it as "unlink destination" before writing to it, although the implementation may not be exactly like that. Since 2.20
10230 * Flags used when an operation may create a file.
10235 * g_cancellable_new:
10237 * Creates a new #GCancellable object.
10238 * Applications that want to start one or more operations
10239 * that should be cancellable should create a #GCancellable
10240 * and pass it to the operations.
10241 * One #GCancellable can be used in multiple consecutive
10242 * operations, but not in multiple concurrent operations.
10244 * Returns: a #GCancellable.
10249 * G_TYPE_PARAM_ENUM:
10251 * The #GType of #GParamSpecEnum.
10256 * g_io_extension_get_priority:
10257 * @extension: a #GIOExtension
10259 * Gets the priority with which @extension was registered.
10261 * Returns: the priority of @extension
10266 * g_file_new_for_commandline_arg:
10267 * @arg: a command line string.
10269 * Creates a #GFile with the given argument from the command line. The value of
10270 * relative to the current working directory.
10271 * This operation never fails, but the returned object might not support any
10272 * I/O operation if @arg points to a malformed path.
10274 * Returns: (transfer full): a new #GFile.
10279 * g_app_info_get_display_name:
10280 * @appinfo: a #GAppInfo.
10282 * Gets the display name of the application. The display name is often more
10283 * descriptive to the user than the name itself.
10284 * no display name is available.
10286 * Returns: the display name of the application for @appinfo, or the name if
10292 * GApplication::activate:
10293 * @application: the application
10295 * The ::activate signal is emitted on the primary instance when an
10296 * activation occurs. See g_application_activate().
10301 * g_proxy_connect_finish:
10302 * @proxy: a #GProxy
10303 * @result: a #GAsyncRetult
10304 * @error: return #GError
10306 * See g_proxy_connect().
10308 * Returns: (transfer full): a #GIOStream.
10314 * g_dbus_node_info_new_for_xml:
10315 * @xml_data: Valid D-Bus introspection XML.
10316 * @error: Return location for error.
10318 * Parses @xml_data and returns a #GDBusNodeInfo representing the data.
10319 * with g_dbus_node_info_unref().
10321 * Returns: A #GDBusNodeInfo structure or %NULL if @error is set. Free
10327 * g_mount_get_icon:
10328 * @mount: a #GMount.
10330 * Gets the icon for @mount.
10331 * The returned object should be unreffed with
10332 * g_object_unref() when no longer needed.
10334 * Returns: (transfer full): a #GIcon.
10339 * g_mount_operation_reply:
10340 * @op: a #GMountOperation
10341 * @result: a #GMountOperationResult
10343 * Emits the #GMountOperation::reply signal.
10348 * g_dbus_property_info_ref:
10349 * @info: A #GDBusPropertyInfo
10351 * If @info is statically allocated does nothing. Otherwise increases
10352 * the reference count.
10354 * Returns: The same @info.
10361 * @g_properties_changed: Signal class handler for the #GDBusProxy::g-properties-changed signal.
10362 * @g_signal: Signal class handler for the #GDBusProxy::g-signal signal.
10364 * Class structure for #GDBusProxy.
10371 * g_themed_icon_new_with_default_fallbacks:
10372 * @iconname: a string containing an icon name
10374 * Creates a new themed icon for @iconname, and all the names
10375 * that can be created by shortening @iconname at '-' characters.
10376 * In the following example, @icon1 and @icon2 are equivalent:
10378 * const char *names[] = {
10379 * "gnome-dev-cdrom-audio",
10380 * "gnome-dev-cdrom",
10384 * icon1 = g_themed_icon_new_from_names (names, 4);
10385 * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
10388 * Returns: (transfer full): a new #GThemedIcon.
10393 * GDataOutputStream:
10395 * An implementation of #GBufferedOutputStream that allows for high-level
10396 * data manipulation of arbitrary data (including binary operations).
10401 * g_action_group_has_action:
10402 * @action_group: a #GActionGroup
10403 * @action_name: the name of the action to check for
10405 * Checks if the named action exists within @action_group.
10407 * Returns: whether the named action exists
10413 * g_buffered_input_stream_fill_async:
10414 * @stream: a #GBufferedInputStream
10415 * @count: the number of bytes that will be read from the stream
10416 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request
10417 * @cancellable: (allow-none): optional #GCancellable object
10418 * @callback: (scope async): a #GAsyncReadyCallback
10419 * @user_data: (closure): a #gpointer
10421 * Reads data into @stream's buffer asynchronously, up to @count size.
10422 * version of this function, see g_buffered_input_stream_fill().
10423 * If @count is -1 then the attempted read size is equal to the number
10424 * of bytes that are required to fill the buffer.
10429 * g_inet_address_get_is_mc_node_local:
10430 * @address: a #GInetAddress
10432 * Tests whether @address is a node-local multicast address.
10434 * Returns: %TRUE if @address is a node-local multicast address.
10441 * @short_description: Volume management
10442 * @include: gio/gio.h
10444 * The #GVolume interface represents user-visible objects that can be
10445 * mounted. Note, when porting from GnomeVFS, #GVolume is the moral
10446 * equivalent of #GnomeVFSDrive.
10447 * Mounting a #GVolume instance is an asynchronous operation. For more
10448 * information about asynchronous operations, see #GAsyncReady and
10449 * #GSimpleAsyncReady. To mount a #GVolume, first call
10450 * g_volume_mount() with (at least) the #GVolume instance, optionally
10451 * a #GMountOperation object and a #GAsyncReadyCallback.
10452 * Typically, one will only want to pass %NULL for the
10453 * #GMountOperation if automounting all volumes when a desktop session
10454 * starts since it's not desirable to put up a lot of dialogs asking
10456 * The callback will be fired when the operation has resolved (either
10457 * with success or failure), and a #GAsyncReady structure will be
10458 * passed to the callback. That callback should then call
10459 * g_volume_mount_finish() with the #GVolume instance and the
10460 * #GAsyncReady data to see if the operation was completed
10461 * successfully. If an @error is present when g_volume_mount_finish()
10462 * is called, then it will be filled with any error information.
10463 * <para id="volume-identifier">
10464 * It is sometimes necessary to directly access the underlying
10465 * operating system object behind a volume (e.g. for passing a volume
10466 * to an application via the commandline). For this purpose, GIO
10467 * allows to obtain an 'identifier' for the volume. There can be
10468 * different kinds of identifiers, such as Hal UDIs, filesystem labels,
10469 * traditional Unix devices (e.g. <filename>/dev/sda2</filename>),
10470 * uuids. GIO uses predefind strings as names for the different kinds
10471 * #G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use g_volume_get_identifier()
10472 * to obtain an identifier for a volume.
10474 * Note that #G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available
10475 * when the gvfs hal volume monitor is in use. Other volume monitors
10476 * will generally be able to provide the #G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE
10477 * identifier, which can be used to obtain a hal device by means of
10478 * libhal_manger_find_device_string_match().
10480 * Of identifiers: #G_VOLUME_IDENTIFIER_KIND_HAL_UDI,
10487 * Generic type for all kinds of icons that can be loaded
10493 * GBufferedInputStream:
10495 * Implements #GFilterInputStream with a sized input buffer.
10500 * g_output_stream_write_async:
10501 * @stream: A #GOutputStream.
10502 * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write.
10503 * @count: the number of bytes to write
10504 * @io_priority: the io priority of the request.
10505 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
10506 * @callback: (scope async): callback to call when the request is satisfied
10507 * @user_data: (closure): the data to pass to callback function
10509 * Request an asynchronous write of @count bytes from @buffer into
10510 * the stream. When the operation is finished @callback will be called.
10511 * You can then call g_output_stream_write_finish() to get the result of the
10513 * During an async request no other sync and async calls are allowed,
10514 * and will result in %G_IO_ERROR_PENDING errors.
10515 * A value of @count larger than %G_MAXSSIZE will cause a
10516 * %G_IO_ERROR_INVALID_ARGUMENT error.
10517 * On success, the number of bytes written will be passed to the
10518 * requested size, as it can happen e.g. on a partial I/O error,
10519 * but generally we try to write as many bytes as requested.
10520 * You are guaranteed that this method will never fail with
10521 * %G_IO_ERROR_WOULD_BLOCK - if @stream can't accept more data, the
10522 * method will just wait until this changes.
10523 * Any outstanding I/O request with higher priority (lower numerical
10524 * value) will be executed before an outstanding request with lower
10525 * priority. Default priority is %G_PRIORITY_DEFAULT.
10526 * The asyncronous methods have a default fallback that uses threads
10527 * to implement asynchronicity, so they are optional for inheriting
10528 * classes. However, if you override one you must override all.
10529 * For the synchronous, blocking version of this function, see
10530 * g_output_stream_write().
10535 * g_tls_certificate_new_from_file:
10536 * @file: file containing a PEM-encoded certificate to import
10537 * @error: #GError for error reporting, or %NULL to ignore.
10539 * Creates a #GTlsCertificate from the PEM-encoded data in @file. If
10540 * set @error. Otherwise, this behaves like g_tls_certificate_new().
10542 * Returns: the new certificate, or %NULL on error
10548 * g_socket_condition_wait:
10549 * @socket: a #GSocket
10550 * @condition: a #GIOCondition mask to wait for
10551 * @cancellable: (allow-none): a #GCancellable, or %NULL
10552 * @error: a #GError pointer, or %NULL
10554 * Waits for @condition to become true on @socket. When the condition
10555 * is met, %TRUE is returned.
10556 * If @cancellable is cancelled before the condition is met, or if the
10557 * socket has a timeout set and it is reached before the condition is
10558 * met, then %FALSE is returned and @error, if non-%NULL, is set to
10559 * the appropriate value (%G_IO_ERROR_CANCELLED or
10560 * %G_IO_ERROR_TIMED_OUT).
10562 * Returns: %TRUE if the condition was met, %FALSE otherwise
10568 * g_dbus_message_to_gerror:
10569 * @message: A #GDBusMessage.
10570 * @error: The #GError to set.
10572 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
10573 * nothing and returns %FALSE.
10574 * Otherwise this method encodes the error in @message as a #GError
10575 * using g_dbus_error_set_dbus_error() using the information in the
10576 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
10577 * well as the first string item in @message's body.
10579 * Returns: %TRUE if @error was set, %FALSE otherwise.
10585 * g_signal_handlers_block_by_func:
10586 * @instance: The instance to block handlers from.
10587 * @func: The C closure callback of the handlers (useless for non-C closures).
10588 * @data: The closure data of the handlers' closures.
10590 * Blocks all handlers on an instance that match @func and @data.
10592 * Returns: The number of handlers that matched.
10597 * g_socket_client_connect_to_service_async:
10598 * @client: a #GSocketClient
10599 * @domain: a domain name
10600 * @service: the name of the service to connect to
10601 * @cancellable: (allow-none): a #GCancellable, or %NULL
10602 * @callback: (scope async): a #GAsyncReadyCallback
10603 * @user_data: (closure): user data for the callback
10605 * This is the asynchronous version of
10606 * g_socket_client_connect_to_service().
10613 * g_mount_operation_get_domain:
10614 * @op: a #GMountOperation.
10616 * Gets the domain of the mount operation.
10618 * Returns: a string set to the domain.
10623 * g_file_info_get_display_name:
10624 * @info: a #GFileInfo.
10626 * Gets a display name for a file.
10628 * Returns: a string containing the display name.
10633 * g_dbus_server_get_client_address:
10634 * @server: A #GDBusServer.
10636 * Gets a D-Bus address string that can be used by clients to connect
10640 * Returns: A D-Bus address string. Do not free, the string is owned
10646 * g_socket_client_connect_to_service:
10647 * @client: a #GSocketConnection
10648 * @domain: a domain name
10649 * @service: the name of the service to connect to
10650 * @cancellable: (allow-none): a #GCancellable, or %NULL
10651 * @error: a pointer to a #GError, or %NULL
10652 * @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error
10654 * Attempts to create a TCP connection to a service.
10655 * This call looks up the SRV record for @service at @domain for the
10656 * "tcp" protocol. It then attempts to connect, in turn, to each of
10657 * the hosts providing the service until either a connection succeeds
10658 * or there are no hosts remaining.
10659 * Upon a successful connection, a new #GSocketConnection is constructed
10660 * and returned. The caller owns this new object and must drop their
10661 * reference to it when finished with it.
10662 * In the event of any failure (DNS error, service not found, no hosts
10663 * connectable) %NULL is returned and @error (if non-%NULL) is set
10669 * g_dbus_connection_register_subtree:
10670 * @connection: A #GDBusConnection.
10671 * @object_path: The object path to register the subtree at.
10672 * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
10673 * @flags: Flags used to fine tune the behavior of the subtree.
10674 * @user_data: Data to pass to functions in @vtable.
10675 * @user_data_free_func: Function to call when the subtree is unregistered.
10676 * @error: Return location for error or %NULL.
10678 * Registers a whole subtree of <quote>dynamic</quote> objects.
10679 * The @enumerate and @introspection functions in @vtable are used to
10680 * convey, to remote callers, what nodes exist in the subtree rooted
10682 * When handling remote calls into any node in the subtree, first the
10683 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
10684 * the @introspection function is used to check if the node supports the
10685 * requested method. If so, the @dispatch function is used to determine
10686 * where to dispatch the call. The collected #GDBusInterfaceVTable and
10687 * #gpointer will be used to call into the interface vtable for processing
10689 * All calls into user-provided code will be invoked in the <link
10690 * linkend="g-main-context-push-thread-default">thread-default main
10691 * loop</link> of the thread you are calling this method from.
10692 * If an existing subtree is already registered at @object_path or
10693 * then @error is set to #G_IO_ERROR_EXISTS.
10694 * Note that it is valid to register regular objects (using
10695 * g_dbus_connection_register_object()) in a subtree registered with
10696 * g_dbus_connection_register_subtree() - if so, the subtree handler
10697 * is tried as the last resort. One way to think about a subtree
10698 * handler is to consider it a <quote>fallback handler</quote>
10699 * for object paths not registered via g_dbus_connection_register_object()
10700 * or other bindings.
10701 * Note that @vtable will be copied so you cannot change it after
10703 * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
10704 * that can be used with g_dbus_connection_unregister_subtree() .
10706 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
10712 * G_VARIANT_TYPE_INT32:
10714 * The type of an integer value that can range from -2147483648 to
10720 * SECTION:gseekabl:
10721 * @short_description: Stream seeking interface
10722 * @include: gio/gio.h
10723 * @see_also: #GInputStream, #GOutputStream
10725 * #GSeekable is implemented by streams (implementations of
10726 * #GInputStream or #GOutputStream) that support seeking.
10731 * GObjectGetPropertyFunc:
10732 * @object: a #GObject
10733 * @property_id: the numeric id under which the property was registered with g_object_class_install_property().
10734 * @value: a #GValue to return the property value in
10735 * @pspec: the #GParamSpec describing the property
10737 * The type of the @get_property function of #GObjectClass.
10742 * g_mount_get_drive:
10743 * @mount: a #GMount.
10745 * Gets the drive for the @mount.
10746 * This is a convenience method for getting the #GVolume and then
10747 * using that object to get the #GDrive.
10748 * The returned object should be unreffed with
10749 * g_object_unref() when no longer needed.
10751 * Returns: (transfer full): a #GDrive or %NULL if @mount is not associated with a volume or a drive.
10756 * g_file_get_parse_name:
10757 * @file: input #GFile.
10759 * Gets the parse name of the @file.
10760 * A parse name is a UTF-8 string that describes the
10761 * file such that one can get the #GFile back using
10762 * g_file_parse_name().
10763 * This is generally used to show the #GFile as a nice
10764 * full-pathname kind of string in a user interface,
10765 * like in a location entry.
10766 * For local files with names that can safely be converted
10767 * to UTF8 the pathname is used, otherwise the IRI is used
10768 * (a form of URI that allows UTF8 characters unescaped).
10769 * This call does no blocking i/o.
10770 * string should be freed with g_free() when no longer needed.
10772 * Returns: a string containing the #GFile's parse name. The returned
10777 * g_resolver_lookup_by_name_async:
10778 * @resolver: a #GResolver
10779 * @hostname: the hostname to look up the address of
10780 * @cancellable: (allow-none): a #GCancellable, or %NULL
10781 * @callback: (scope async): callback to call after resolution completes
10782 * @user_data: (closure): data for @callback
10784 * Begins asynchronously resolving @hostname to determine its
10785 * associated IP address(es), and eventually calls @callback, which
10786 * must call g_resolver_lookup_by_name_finish() to get the result.
10787 * See g_resolver_lookup_by_name() for more details.
10794 * GBusNameVanishedCallback:
10795 * @connection: The #GDBusConnection the name is being watched on.
10796 * @name: The name being watched.
10797 * @user_data: User data passed to g_bus_watch_name().
10799 * Invoked when the name being watched is known not to have to have a owner.
10806 * SECTION:gfilteroutputstrea:
10807 * @short_description: Filter Output Stream
10808 * @include: gio/gio.h
10810 * Base class for output stream implementations that perform some
10811 * kind of filtering operation on a base stream. Typical examples
10812 * of filtering operations are character set conversion, compression
10813 * and byte order flipping.
10819 * @value: the enum value
10820 * @value_name: the name of the value
10821 * @value_nick: the nickname of the value
10823 * A structure which contains a single enum value, its name, and its
10830 * @file1: the first #GFile.
10831 * @file2: the second #GFile.
10833 * Checks equality of two given #GFile<!-- -->s. Note that two
10834 * #GFile<!-- -->s that differ can still refer to the same
10835 * file on the filesystem due to various forms of filename
10837 * This call does no blocking i/o.
10838 * %FALSE if either is not a #GFile.
10840 * Returns: %TRUE if @file1 and @file2 are equal.
10846 * @G_OPTION_ARG_NONE: No extra argument. This is useful for simple flags.
10847 * @G_OPTION_ARG_STRING: The option takes a string argument.
10848 * @G_OPTION_ARG_INT: The option takes an integer argument.
10849 * @G_OPTION_ARG_CALLBACK: The option provides a callback to parse the extra argument.
10850 * @G_OPTION_ARG_FILENAME: The option takes a filename as argument.
10851 * @G_OPTION_ARG_STRING_ARRAY: The option takes a string argument, multiple uses of the option are collected into an array of strings.
10852 * @G_OPTION_ARG_FILENAME_ARRAY: The option takes a filename as argument, multiple uses of the option are collected into an array of strings.
10853 * @G_OPTION_ARG_DOUBLE: 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
10854 * @G_OPTION_ARG_INT64: 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 <literal>0x</literal>, for example, <literal>0xffffffff</literal>). Since 2.12
10856 * The #GOptionArg enum values determine which type of extra argument the
10857 * options expect to find. If an option expects an extra argument, it
10858 * can be specified in several ways; with a short option:
10859 * <option>-x arg</option>, with a long option: <option>--name arg</option>
10861 * Or combined in a single argument: <option>--name=arg</option>.
10866 * g_file_set_attributes_async:
10867 * @file: input #GFile.
10868 * @info: a #GFileInfo.
10869 * @flags: a #GFileQueryInfoFlags.
10870 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
10871 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
10872 * @callback: (scope async): a #GAsyncReadyCallback.
10873 * @user_data: (closure): a #gpointer.
10875 * Asynchronously sets the attributes of @file with @info.
10876 * For more details, see g_file_set_attributes_from_info() which is
10877 * the synchronous version of this call.
10878 * When the operation is finished, @callback will be called. You can then call
10879 * g_file_set_attributes_finish() to get the result of the operation.
10884 * SECTION:gcharsetconverte:
10885 * @short_description: Convert between charsets
10886 * @include: gio/gio.h
10888 * #GCharsetConverter is an implementation of #GConverter based on
10894 * G_VALUE_HOLDS_INT:
10895 * @value: a valid #GValue structure
10897 * Checks whether the given #GValue can hold values of type %G_TYPE_INT.
10899 * Returns: %TRUE on success.
10904 * g_dbus_method_invocation_get_parameters:
10905 * @invocation: A #GDBusMethodInvocation.
10907 * Gets the parameters of the method invocation.
10909 * Returns: A #GVariant. Do not free, it is owned by @invocation.
10915 * g_output_stream_close_async:
10916 * @stream: A #GOutputStream.
10917 * @io_priority: the io priority of the request.
10918 * @cancellable: (allow-none): optional cancellable object
10919 * @callback: (scope async): callback to call when the request is satisfied
10920 * @user_data: (closure): the data to pass to callback function
10922 * Requests an asynchronous close of the stream, releasing resources
10923 * related to it. When the operation is finished @callback will be
10924 * called. You can then call g_output_stream_close_finish() to get
10925 * the result of the operation.
10926 * For behaviour details see g_output_stream_close().
10927 * The asyncronous methods have a default fallback that uses threads
10928 * to implement asynchronicity, so they are optional for inheriting
10929 * classes. However, if you override one you must override all.
10934 * G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT:
10936 * A key in the "unix" namespace for checking if the file represents a
10937 * UNIX mount point. This attribute is %TRUE if the file is a UNIX mount
10938 * point. This attribute is only available for UNIX file systems.
10939 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
10944 * g_dbus_message_to_blob:
10945 * @message: A #GDBusMessage.
10946 * @out_size: Return location for size of generated blob.
10947 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
10948 * @error: Return location for error.
10950 * Serializes @message to a blob. The byte order returned by
10951 * g_dbus_message_get_byte_order() will be used.
10952 * generated by @message or %NULL if @error is set. Free with g_free().
10954 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
10960 * SECTION:giostrea:
10961 * @short_description: Base class for implementing read/write streams
10962 * @include: gio/gio.h
10963 * @see_also: #GInputStream, #GOutputStream
10965 * GIOStream represents an object that has both read and write streams.
10966 * Generally the two streams acts as separate input and output streams,
10967 * but they share some common resources and state. For instance, for
10968 * seekable streams they may use the same position in both streams.
10969 * Examples of #GIOStream objects are #GSocketConnection which represents
10970 * a two-way network connection, and #GFileIOStream which represent a
10971 * file handle opened in read-write mode.
10972 * To do the actual reading and writing you need to get the substreams
10973 * with g_io_stream_get_input_stream() and g_io_stream_get_output_stream().
10974 * The #GIOStream object owns the input and the output streams, not the other
10975 * way around, so keeping the substreams alive will not keep the #GIOStream
10976 * object alive. If the #GIOStream object is freed it will be closed, thus
10977 * closing the substream, so even if the substreams stay alive they will
10978 * always just return a %G_IO_ERROR_CLOSED for all operations.
10979 * To close a stream use g_io_stream_close() which will close the common
10980 * stream object and also the individual substreams. You can also close
10981 * the substreams themselves. In most cases this only marks the
10982 * substream as closed, so further I/O on it fails. However, some streams
10983 * may support "half-closed" states where one direction of the stream
10984 * is actually shut down.
10991 * g_socket_client_get_local_address:
10992 * @client: a #GSocketClient.
10994 * Gets the local address of the socket client.
10995 * See g_socket_client_set_local_address() for details.
10997 * Returns: (transfer none): a #GSocketAddres or %NULL. don't free
11003 * g_data_input_stream_read_uint64:
11004 * @stream: a given #GDataInputStream.
11005 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
11006 * @error: #GError for error reporting.
11008 * Reads an unsigned 64-bit/8-byte value from @stream.
11009 * In order to get the correct byte order for this read operation,
11010 * see g_data_input_stream_get_byte_order().
11011 * If @cancellable is not %NULL, then the operation can be cancelled by
11012 * triggering the cancellable object from another thread. If the operation
11013 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
11014 * an error occurred.
11016 * Returns: an unsigned 64-bit/8-byte read from @stream or %0 if
11022 * @proxy: a #GProxy
11023 * @connection: a #GIOStream
11024 * @proxy_address: a #GProxyAddress
11025 * @cancellable: (allow-none): a #GCancellable
11026 * @error: return #GError
11028 * Given @connection to communicate with a proxy (eg, a
11029 * #GSocketConnection that is connected to the proxy server), this
11030 * does the necessary handshake to connect to @proxy_address, and if
11031 * required, wraps the #GIOStream to handle proxy payload.
11032 * be the same as @connection, in which case a reference
11035 * Returns: (transfer full): a #GIOStream that will replace @connection. This might
11041 * g_content_type_guess:
11042 * @filename: (allow-none): a string, or %NULL
11043 * @data: (allow-none) (array length=data_size): a stream of data, or %NULL
11044 * @data_size: the size of @data
11045 * @result_uncertain: (allow-none) (out): return location for the certainty of the result, or %NULL
11047 * Guesses the content type based on example data. If the function is
11048 * uncertain, @result_uncertain will be set to %TRUE. Either @filename
11049 * or @data may be %NULL, in which case the guess will be based solely
11050 * on the other argument.
11051 * given data. Free with g_free()
11053 * Returns: a string indicating a guessed content type for the
11058 * g_settings_backend_keys_changed:
11059 * @backend: a #GSettingsBackend implementation
11060 * @path: the path containing the changes
11061 * @items: the %NULL-terminated list of changed keys
11062 * @origin_tag: the origin tag
11064 * Signals that a list of keys have possibly changed. Backend
11065 * implementations should call this if keys have possibly changed their
11067 * not containing '//'). Each string in @items must form a valid key
11068 * end with '/' and must not contain '//').
11069 * The meaning of this signal is that any of the key names resulting
11070 * from the contatenation of @path with each item in @items may have
11072 * The same rules for when notifications must occur apply as per
11073 * g_settings_backend_changed(). These two calls can be used
11074 * interchangeably if exactly one item has changed (although in that
11075 * case g_settings_backend_changed() is definitely preferred).
11076 * For efficiency reasons, the implementation should strive for @path to
11077 * keys that were changed) but this is not strictly required.
11079 * Name when @path is prefixed to it (ie: each item must not start or
11080 * Be as long as possible (ie: the longest common prefix of all of the
11086 * GDataStreamNewlineType:
11087 * @G_DATA_STREAM_NEWLINE_TYPE_LF: Selects "LF" line endings, common on most modern UNIX platforms.
11088 * @G_DATA_STREAM_NEWLINE_TYPE_CR: Selects "CR" line endings.
11089 * @G_DATA_STREAM_NEWLINE_TYPE_CR_LF: Selects "CR, LF" line ending, common on Microsoft Windows.
11090 * @G_DATA_STREAM_NEWLINE_TYPE_ANY: Automatically try to handle any line ending type.
11092 * #GDataStreamNewlineType is used when checking for or setting the line endings for a given file.
11098 * @buffer: Pointer to a buffer of data to read.
11099 * @size: the size of @buffer.
11101 * Structure used for scatter/gather data output.
11102 * You generally pass in an array of #GOutputVector<!-- -->s
11103 * and the operation will use all the buffers as if they were
11111 * g_file_query_writable_namespaces:
11112 * @file: input #GFile.
11113 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
11114 * @error: a #GError, or %NULL
11116 * Obtain the list of attribute namespaces where new attributes
11117 * can be created by a user. An example of this is extended
11118 * attributes (in the "xattr" namespace).
11119 * If @cancellable is not %NULL, then the operation can be cancelled by
11120 * triggering the cancellable object from another thread. If the operation
11121 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
11122 * When you are done with it, release it with g_file_attribute_info_list_unref()
11124 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
11129 * g_file_eject_mountable_with_operation:
11130 * @file: input #GFile.
11131 * @flags: flags affecting the operation
11132 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
11133 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
11134 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
11135 * @user_data: (closure): the data to pass to callback function
11137 * Starts an asynchronous eject on a mountable.
11138 * When this operation has completed, @callback will be called with
11139 * g_file_eject_mountable_with_operation_finish().
11140 * If @cancellable is not %NULL, then the operation can be cancelled by
11141 * triggering the cancellable object from another thread. If the operation
11142 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
11149 * G_TYPE_PTR_ARRAY:
11151 * The #GType for a boxed type holding a #GPtrArray reference.
11158 * g_dbus_message_new_method_error_valist:
11159 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to.
11160 * @error_name: A valid D-Bus error name.
11161 * @error_message_format: The D-Bus error message in a printf() format.
11162 * @var_args: Arguments for @error_message_format.
11164 * Like g_dbus_message_new_method_error() but intended for language bindings.
11166 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
11172 * g_socket_set_listen_backlog:
11173 * @socket: a #GSocket.
11174 * @backlog: the maximum number of pending connections.
11176 * Sets the maximum number of outstanding connections allowed
11177 * when listening on this socket. If more clients than this are
11178 * connecting to the socket and the application is not handling them
11179 * on time then the new connections will be refused.
11180 * Note that this must be called before g_socket_listen() and has no
11181 * effect if called after that.
11188 * G_IS_PARAM_SPEC_POINTER:
11189 * @pspec: a valid #GParamSpec instance
11191 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER.
11193 * Returns: %TRUE on success.
11198 * GUnixCredentialsMessageClass:
11200 * Class structure for #GUnixCredentialsMessage.
11207 * g_proxy_resolver_get_default:
11209 * Gets the default #GProxyResolver for the system.
11211 * Returns: (transfer none): the default #GProxyResolver.
11217 * g_settings_delay:
11218 * @settings: a #GSettings object
11220 * Changes the #GSettings object into 'delay-apply' mode. In this
11221 * mode, changes to @settings are not immediately propagated to the
11222 * backend, but kept locally until g_settings_apply() is called.
11229 * GMemoryOutputStream:destroy-function: (skip)
11231 * Function called with the buffer as argument when the stream is destroyed.
11238 * GFileInputStream:
11240 * A subclass of GInputStream for opened files. This adds
11241 * a few file-specific operations and seeking.
11242 * #GFileInputStream implements #GSeekable.
11247 * SECTION:gwin32outputstrea:
11248 * @short_description: Streaming output operations for Windows file handles
11249 * @include: gio/gwin32outputstream.h
11250 * @see_also: #GOutputStream
11252 * #GWin32OutputStream implements #GOutputStream for writing to a
11253 * Windows file handle.
11254 * Note that <filename><gio/gwin32outputstream.h></filename> belongs
11255 * to the Windows-specific GIO interfaces, thus you have to use the
11256 * <filename>gio-windows-2.0.pc</filename> pkg-config file when using it.
11261 * g_file_monitor_is_cancelled:
11262 * @monitor: a #GFileMonitor
11264 * Returns whether the monitor is canceled.
11266 * Returns: %TRUE if monitor is canceled. %FALSE otherwise.
11271 * G_PARAM_SPEC_CLASS:
11272 * @pclass: a valid #GParamSpecClass
11274 * Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure.
11279 * g_file_set_attributes_from_info:
11280 * @file: input #GFile.
11281 * @info: a #GFileInfo.
11282 * @flags: #GFileQueryInfoFlags
11283 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
11284 * @error: a #GError, or %NULL
11286 * Tries to set all attributes in the #GFileInfo on the target values,
11287 * not stopping on the first error.
11288 * If there is any error during this operation then @error will be set to
11289 * the first error. Error on particular fields are flagged by setting
11290 * the "status" field in the attribute value to
11291 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
11293 * If @cancellable is not %NULL, then the operation can be cancelled by
11294 * triggering the cancellable object from another thread. If the operation
11295 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
11297 * Returns: %TRUE if there was any error, %FALSE otherwise.
11302 * G_TYPE_IS_ABSTRACT:
11303 * @type: A #GType value.
11305 * Checks if @type is an abstract type. An abstract type can not be
11306 * instantiated and is normally used as an abstract base class for
11309 * Returns: %TRUE on success.
11314 * g_settings_is_writable:
11315 * @settings: a #GSettings object
11316 * @name: the name of a key
11317 * @returns: %TRUE if the key @name is writable
11319 * Finds out if a key can be written or not
11328 * The type used for callback functions in structure definitions and function
11329 * signatures. This doesn't mean that all callback functions must take no
11330 * parameters and return void. The required signature of a callback function
11331 * is determined by the context in which is used (e.g. the signal to which it
11332 * is connected). Use G_CALLBACK() to cast the callback function to a #GCallback.
11337 * g_file_create_async:
11338 * @file: input #GFile.
11339 * @flags: a set of #GFileCreateFlags.
11340 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
11341 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
11342 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
11343 * @user_data: (closure): the data to pass to callback function
11345 * Asynchronously creates a new file and returns an output stream for writing to it.
11346 * The file must not already exist.
11347 * For more details, see g_file_create() which is
11348 * the synchronous version of this call.
11349 * When the operation is finished, @callback will be called. You can then call
11350 * g_file_create_finish() to get the result of the operation.
11355 * g_output_stream_splice_finish:
11356 * @stream: a #GOutputStream.
11357 * @result: a #GAsyncResult.
11358 * @error: a #GError location to store the error occuring, or %NULL to ignore.
11360 * Finishes an asynchronous stream splice operation.
11362 * Returns: a #gssize of the number of bytes spliced.
11367 * g_socket_shutdown:
11368 * @socket: a #GSocket
11369 * @shutdown_read: whether to shut down the read side
11370 * @shutdown_write: whether to shut down the write side
11371 * @error: #GError for error reporting, or %NULL to ignore.
11373 * Shut down part of a full-duplex connection.
11374 * If @shutdown_read is %TRUE then the recieving side of the connection
11375 * is shut down, and further reading is disallowed.
11376 * If @shutdown_write is %TRUE then the sending side of the connection
11377 * is shut down, and further writing is disallowed.
11378 * It is allowed for both @shutdown_read and @shutdown_write to be %TRUE.
11379 * One example where this is used is graceful disconnect for TCP connections
11380 * where you close the sending side, then wait for the other side to close
11381 * the connection, thus ensuring that the other side saw all sent data.
11383 * Returns: %TRUE on success, %FALSE on error
11389 * G_PARAM_SPEC_DOUBLE:
11390 * @pspec: a valid #GParamSpec instance
11392 * Cast a #GParamSpec instance into a #GParamSpecDouble.
11397 * g_file_get_relative_path:
11398 * @parent: input #GFile.
11399 * @descendant: input #GFile.
11401 * Gets the path for @descendant relative to @parent.
11402 * This call does no blocking i/o.
11403 * to @parent, or %NULL if @descendant doesn't have @parent as prefix.
11404 * The returned string should be freed with g_free() when no longer needed.
11406 * Returns: string with the relative path from @descendant
11411 * g_simple_async_result_take_error: (skip)
11412 * @simple: a #GSimpleAsyncResult
11413 * @error: a #GError
11415 * Sets the result from @error, and takes over the caller's ownership
11416 * of @error, so the caller does not need to free it any more.
11424 * @data: data specified when registering the notification callback
11425 * @closure: the #GClosure on which the notification is emitted
11427 * The type used for the various notification callbacks which can be registered
11433 * g_unix_is_mount_path_system_internal:
11434 * @mount_path: a mount path, e.g. <filename>/media/disk</filename> or <filename>/usr</filename>
11436 * Determines if @mount_path is considered an implementation of the
11437 * OS. This is primarily used for hiding mountable and mounted volumes
11438 * that only are used in the OS and has little to no relevance to the
11442 * Returns: %TRUE if @mount_path is considered an implementation detail
11447 * g_emblemed_icon_new:
11449 * @emblem: (allow-none): a #GEmblem, or %NULL
11451 * Creates a new emblemed icon for @icon with the emblem @emblem.
11453 * Returns: (transfer full): a new #GIcon
11459 * G_TYPE_DBUS_ANNOTATION_INFO:
11461 * The #GType for a boxed type holding a #GDBusAnnotationInfo.
11468 * GSignalInvocationHint:
11469 * @signal_id: The signal id of the signal invoking the callback
11470 * @detail: The detail passed on for this emission
11471 * @run_type: 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.
11473 * The #GSignalInvocationHint structure is used to pass on additional information
11474 * to callbacks during a signal emission.
11479 * g_tls_connection_get_peer_certificate:
11480 * @conn: a #GTlsConnection
11482 * Gets @conn's peer's certificate after the handshake has completed.
11483 * (It is not set during the emission of
11484 * #GTlsConnection::accept-certificate.)
11486 * Returns: (transfer none): @conn's peer's certificate, or %NULL
11492 * g_file_eject_mountable_finish:
11493 * @file: input #GFile.
11494 * @result: a #GAsyncResult.
11495 * @error: a #GError, or %NULL
11497 * Finishes an asynchronous eject operation started by
11498 * g_file_eject_mountable().
11501 * Returns: %TRUE if the @file was ejected successfully. %FALSE
11502 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead.
11509 * Returns a new #GVfs handle for a local vfs.
11511 * Returns: a new #GVfs handle.
11516 * GDBusServer::new-connection:
11517 * @server: The #GDBusServer emitting the signal.
11518 * @connection: A #GDBusConnection for the new connection.
11520 * Emitted when a new authenticated connection has been made. Use
11521 * g_dbus_connection_get_peer_credentials() to figure out what
11522 * identity (if any), was authenticated.
11523 * If you want to accept the connection, take a reference to the
11524 * connection call g_dbus_connection_close() and give up your
11525 * reference. Note that the other peer may disconnect at any time -
11526 * a typical thing to do when accepting a connection is to listen to
11527 * the #GDBusConnection::closed signal.
11528 * If #GDBusServer:flags contains %G_DBUS_SERVER_FLAGS_RUN_IN_THREAD
11529 * then the signal is emitted in a new thread dedicated to the
11530 * connection. Otherwise the signal is emitted in the <link
11531 * linkend="g-main-context-push-thread-default">thread-default main
11532 * loop</link> of the thread that @server was constructed in.
11533 * You are guaranteed that signal handlers for this signal runs
11534 * before incoming messages on @connection are processed. This means
11535 * that it's suitable to call g_dbus_connection_register_object() or
11536 * similar from the signal handler.
11539 * Returns: %TRUE to claim @connection, %FALSE to let other handlers
11545 * g_tls_backend_get_certificate_type:
11546 * @backend: the #GTlsBackend
11548 * Gets the #GType of @backend's #GTlsCertificate implementation.
11551 * Returns: the #GType of @backend's #GTlsCertificate
11557 * g_action_group_action_added:
11558 * @action_group: a #GActionGroup
11559 * @action_name: the name of an action in the group
11561 * Emits the #GActionGroup::action-added signal on @action_group.
11562 * This function should only be called by #GActionGroup implementations.
11569 * g_output_stream_has_pending:
11570 * @stream: a #GOutputStream.
11572 * Checks if an ouput stream has pending actions.
11574 * Returns: %TRUE if @stream has pending actions.
11579 * GDBusConnection:capabilities:
11581 * Flags from the #GDBusCapabilityFlags enumeration
11582 * representing connection features negotiated with the other peer.
11590 * @data: memory block to reallocate
11591 * @size: size to reallocate @data to
11593 * Changes the size of the memory block pointed to by @data to
11594 * The function should have the same semantics as realloc().
11596 * Returns: a pointer to the reallocated memory
11601 * g_dbus_error_unregister_error:
11602 * @error_domain: A #GQuark for a error domain.
11603 * @error_code: An error code.
11604 * @dbus_error_name: A D-Bus error name.
11606 * Destroys an association previously set up with g_dbus_error_register_error().
11608 * Returns: %TRUE if the association was destroyed, %FALSE if it wasn't found.
11614 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START:
11616 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started.
11617 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
11624 * SECTION:gcancellabl:
11625 * @short_description: Thread-safe Operation Cancellation Stack
11626 * @include: gio/gio.h
11628 * GCancellable is a thread-safe operation cancellation stack used
11629 * throughout GIO to allow for cancellation of synchronous and
11630 * asynchronous operations.
11635 * g_buffered_input_stream_peek:
11636 * @stream: a #GBufferedInputStream
11637 * @buffer: a pointer to an allocated chunk of memory
11638 * @offset: a #gsize
11641 * Peeks in the buffer, copying data of size @count into @buffer,
11642 * offset @offset bytes.
11644 * Returns: a #gsize of the number of bytes peeked, or -1 on error.
11649 * g_file_is_native:
11650 * @file: input #GFile.
11652 * Checks to see if a file is native to the platform.
11653 * A native file s one expressed in the platform-native filename format,
11654 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
11655 * as it might be on a locally mounted remote filesystem.
11656 * On some systems non-native files may be available using
11657 * the native filesystem via a userspace filesystem (FUSE), in
11658 * these cases this call will return %FALSE, but g_file_get_path()
11659 * will still return a native path.
11660 * This call does no blocking i/o.
11662 * Returns: %TRUE if file is native.
11667 * g_file_set_attribute_uint64:
11668 * @file: input #GFile.
11669 * @attribute: a string containing the attribute's name.
11670 * @value: a #guint64 containing the attribute's new value.
11671 * @flags: a #GFileQueryInfoFlags.
11672 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
11673 * @error: a #GError, or %NULL
11675 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
11676 * If @attribute is of a different type, this operation will fail.
11677 * If @cancellable is not %NULL, then the operation can be cancelled by
11678 * triggering the cancellable object from another thread. If the operation
11679 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
11680 * in the @file, %FALSE otherwise.
11682 * Returns: %TRUE if the @attribute was successfully set to @value
11687 * g_output_stream_flush_finish:
11688 * @stream: a #GOutputStream.
11689 * @result: a GAsyncResult.
11690 * @error: a #GError location to store the error occuring, or %NULL to ignore.
11692 * Finishes flushing an output stream.
11694 * Returns: %TRUE if flush operation suceeded, %FALSE otherwise.
11699 * g_volume_get_icon:
11700 * @volume: a #GVolume.
11702 * Gets the icon for @volume.
11703 * The returned object should be unreffed with g_object_unref()
11704 * when no longer needed.
11706 * Returns: (transfer full): a #GIcon.
11711 * GMountOperation::aborted:
11713 * Emitted by the backend when e.g. a device becomes unavailable
11714 * while a mount operation is in progress.
11715 * Implementations of GMountOperation should handle this signal
11716 * by dismissing open password dialogs.
11723 * g_charset_converter_get_use_fallback:
11724 * @converter: a #GCharsetConverter
11726 * Gets the #GCharsetConverter:use-fallback property.
11728 * Returns: %TRUE if fallbacks are used by @converter
11734 * g_win32_output_stream_set_close_handle:
11735 * @stream: a #GWin32OutputStream
11736 * @close_handle: %TRUE to close the handle when done
11738 * Sets whether the handle of @stream shall be closed when the stream
11746 * g_converter_convert:
11747 * @converter: a #GConverter.
11748 * @inbuf: (array length=inbuf_size) (element-type guint8): the buffer containing the data to convert.
11749 * @inbuf_size: the number of bytes in @inbuf
11750 * @outbuf: a buffer to write converted data in.
11751 * @outbuf_size: the number of bytes in @outbuf, must be at least one
11752 * @flags: a #GConvertFlags controlling the conversion details
11753 * @bytes_read: (out): will be set to the number of bytes read from @inbuf on success
11754 * @bytes_written: (out): will be set to the number of bytes written to @outbuf on success
11755 * @error: location to store the error occuring, or %NULL to ignore
11757 * This is the main operation used when converting data. It is to be called
11758 * multiple times in a loop, and each time it will do some work, i.e.
11759 * producing some output (in @outbuf) or consuming some input (from @inbuf) or
11760 * both. If its not possible to do any work an error is returned.
11761 * Note that a single call may not consume all input (or any input at all).
11762 * Also a call may produce output even if given no input, due to state stored
11763 * in the converter producing output.
11764 * If any data was either produced or consumed, and then an error happens, then
11765 * only the successful conversion is reported and the error is returned on the
11767 * A full conversion loop involves calling this method repeatedly, each time
11768 * giving it new input and space output space. When there is no more input
11769 * data after the data in @inbuf, the flag %G_CONVERTER_INPUT_AT_END must be set.
11770 * The loop will be (unless some error happens) returning %G_CONVERTER_CONVERTED
11771 * each time until all data is consumed and all output is produced, then
11772 * %G_CONVERTER_FINISHED is returned instead. Note, that %G_CONVERTER_FINISHED
11773 * may be returned even if %G_CONVERTER_INPUT_AT_END is not set, for instance
11774 * in a decompression converter where the end of data is detectable from the
11775 * data (and there might even be other data after the end of the compressed data).
11776 * When some data has successfully been converted @bytes_read and is set to
11777 * the number of bytes read from @inbuf, and @bytes_written is set to indicate
11778 * how many bytes was written to @outbuf. If there are more data to output
11779 * or consume (i.e. unless the G_CONVERTER_INPUT_AT_END is specified) then
11780 * G_CONVERTER_CONVERTED is returned, and if no more data is to be output
11781 * then G_CONVERTER_FINISHED is returned.
11782 * On error %G_CONVERTER_ERROR is returned and @error is set accordingly.
11783 * Some errors need special handling:
11784 * %G_IO_ERROR_NO_SPACE is returned if there is not enough space
11785 * to write the resulting converted data, the application should
11786 * call the function again with a larger @outbuf to continue.
11787 * %G_IO_ERROR_PARTIAL_INPUT is returned if there is not enough
11788 * input to fully determine what the conversion should produce,
11789 * and the %G_CONVERTER_INPUT_AT_END flag is not set. This happens for
11790 * example with an incomplete multibyte sequence when converting text,
11791 * or when a regexp matches up to the end of the input (and may match
11792 * further input). It may also happen when @inbuf_size is zero and
11793 * there is no more data to produce.
11794 * When this happens the application should read more input and then
11795 * call the function again. If further input shows that there is no
11796 * more data call the function again with the same data but with
11797 * the %G_CONVERTER_INPUT_AT_END flag set. This may cause the conversion
11798 * to finish as e.g. in the regexp match case (or, to fail again with
11799 * %G_IO_ERROR_PARTIAL_INPUT in e.g. a charset conversion where the
11800 * input is actually partial).
11801 * After g_converter_convert() has returned %G_CONVERTER_FINISHED the
11802 * converter object is in an invalid state where its not allowed
11803 * to call g_converter_convert() anymore. At this time you can only
11804 * free the object or call g_converter_reset() to reset it to the
11806 * If the flag %G_CONVERTER_FLUSH is set then conversion is modified
11807 * to try to write out all internal state to the output. The application
11808 * has to call the function multiple times with the flag set, and when
11809 * the availible input has been consumed and all internal state has
11810 * been produced then %G_CONVERTER_FLUSHED (or %G_CONVERTER_FINISHED if
11811 * really at the end) is returned instead of %G_CONVERTER_CONVERTED.
11812 * This is somewhat similar to what happens at the end of the input stream,
11813 * but done in the middle of the data.
11814 * This has different meanings for different conversions. For instance
11815 * in a compression converter it would mean that we flush all the
11816 * compression state into output such that if you uncompress the
11817 * compressed data you get back all the input data. Doing this may
11818 * make the final file larger due to padding though. Another example
11819 * is a regexp conversion, where if you at the end of the flushed data
11820 * have a match, but there is also a potential longer match. In the
11821 * non-flushed case we would ask for more input, but when flushing we
11822 * treat this as the end of input and do the match.
11823 * Flushing is not always possible (like if a charset converter flushes
11824 * at a partial multibyte sequence). Converters are supposed to try
11825 * to produce as much output as possible and then return an error
11826 * (typically %G_IO_ERROR_PARTIAL_INPUT).
11828 * Returns: a #GConverterResult, %G_CONVERTER_ERROR on error.
11834 * G_INITIALLY_UNOWNED:
11835 * @object: Object which is subject to casting.
11837 * Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
11838 * pointer. Depending on the current debugging level, this function may invoke
11839 * certain runtime checks to identify invalid casts.
11844 * g_unix_mounts_changed_since:
11845 * @time: guint64 to contain a timestamp.
11847 * Checks if the unix mounts have changed since a given unix time.
11849 * Returns: %TRUE if the mounts have changed since @time.
11856 * The state of the action, or %NULL if the action is stateless.
11863 * g_file_info_get_attribute_int64:
11864 * @info: a #GFileInfo.
11865 * @attribute: a file attribute key.
11867 * Gets a signed 64-bit integer contained within the attribute. If the
11868 * attribute does not contain an signed 64-bit integer, or is invalid,
11869 * 0 will be returned.
11871 * Returns: a signed 64-bit integer from the attribute.
11876 * g_unix_socket_address_get_is_abstract:
11877 * @address: a #GInetSocketAddress
11879 * Tests if @address is abstract.
11881 * Returns: %TRUE if the address is abstract, %FALSE otherwise
11883 * Deprecated: Use g_unix_socket_address_get_address_type()
11888 * g_io_extension_get_name:
11889 * @extension: a #GIOExtension
11891 * Gets the name under which @extension was registered.
11892 * Note that the same type may be registered as extension
11893 * for multiple extension points, under different names.
11895 * Returns: the name of @extension.
11902 * A #GSocketConnection for UNIX domain socket connections.
11909 * g_settings_backend_changed_tree:
11910 * @backend: a #GSettingsBackend implementation
11911 * @tree: a #GTree containing the changes
11912 * @origin_tag: the origin tag
11914 * This call is a convenience wrapper. It gets the list of changes from
11915 * g_settings_backend_changed().
11922 * g_socket_client_connect_to_host:
11923 * @client: a #GSocketClient
11924 * @host_and_port: the name and optionally port of the host to connect to
11925 * @default_port: the default port to connect to
11926 * @cancellable: (allow-none): a #GCancellable, or %NULL
11927 * @error: a pointer to a #GError, or %NULL
11929 * This is a helper function for g_socket_client_connect().
11930 * Attempts to create a TCP connection to the named host.
11931 * address, an IPv4 address, or a domain name (in which case a DNS
11932 * lookup is performed). Quoting with [] is supported for all address
11933 * types. A port override may be specified in the usual way with a
11934 * colon. Ports may be given as decimal numbers or symbolic names (in
11935 * which case an /etc/services lookup is performed).
11936 * If no port override is given in @host_and_port then @default_port will be
11937 * used as the port number to connect to.
11938 * In general, @host_and_port is expected to be provided by the user (allowing
11939 * them to give the hostname, and a port overide if necessary) and
11940 * In the case that an IP address is given, a single connection
11941 * attempt is made. In the case that a name is given, multiple
11942 * connection attempts may be made, in turn and according to the
11943 * number of address records in DNS, until a connection succeeds.
11944 * Upon a successful connection, a new #GSocketConnection is constructed
11945 * and returned. The caller owns this new object and must drop their
11946 * reference to it when finished with it.
11947 * In the event of any failure (DNS error, service not found, no hosts
11948 * connectable) %NULL is returned and @error (if non-%NULL) is set
11951 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
11958 * @title: TLS Overview
11959 * @short_description: TLS (aka SSL) support for GSocketConnection
11960 * @include: gio/gio.h
11962 * #GTlsConnection and related classes provide TLS (Transport Layer
11963 * Security, previously known as SSL, Secure Sockets Layer) support for
11964 * gio-based network streams.
11965 * In the simplest case, for a client connection, you can just set the
11966 * #GSocketClient:tls flag on a #GSocketClient, and then any
11967 * connections created by that client will have TLS negotiated
11968 * automatically, using appropriate default settings, and rejecting
11969 * any invalid or self-signed certificates (unless you change that
11970 * default by setting the #GSocketClient:tls-validation-flags
11971 * property). The returned object will be a #GTcpWrapperConnection,
11972 * which wraps the underlying #GTlsClientConnection.
11973 * For greater control, you can create your own #GTlsClientConnection,
11974 * wrapping a #GSocketConnection (or an arbitrary #GIOStream with
11975 * pollable input and output streams) and then connect to its signals,
11976 * such as #GTlsConnection::accept-certificate, before starting the
11978 * Server-side TLS is similar, using #GTlsServerConnection. At the
11979 * moment, there is no support for automatically wrapping server-side
11980 * connections in the way #GSocketClient does for client-side
11986 * GDBusSubtreeEnumerateFunc:
11987 * @connection: A #GDBusConnection.
11988 * @sender: The unique bus name of the remote caller.
11989 * @object_path: The object path that was registered with g_dbus_connection_register_subtree().
11990 * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
11992 * The type of the @enumerate function in #GDBusSubtreeVTable.
11993 * This function is called when generating introspection data and also
11994 * when preparing to dispatch incoming messages in the event that the
11995 * %G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is not
11996 * Hierarchies are not supported; the items that you return should not
11997 * contain the '/' character.
11998 * The return value will be freed with g_strfreev().
12000 * Specified (ie: to verify that the object path is valid).
12001 * Returns: A newly allocated array of strings for node names that are children of @object_path.
12007 * g_srv_target_new:
12008 * @hostname: the host that the service is running on
12009 * @port: the port that the service is running on
12010 * @priority: the target's priority
12011 * @weight: the target's weight
12013 * Creates a new #GSrvTarget with the given parameters.
12014 * You should not need to use this; normally #GSrvTarget<!-- -->s are
12015 * created by #GResolver.
12017 * Returns: a new #GSrvTarget.
12023 * g_simple_async_report_error_in_idle: (skip)
12024 * @object: (allow-none): a #GObject, or %NULL.
12025 * @callback: a #GAsyncReadyCallback.
12026 * @user_data: user data passed to @callback.
12027 * @domain: a #GQuark containing the error domain (usually #G_IO_ERROR).
12028 * @code: a specific error code.
12029 * @format: a formatted error reporting string.
12030 * @...: a list of variables to fill in @format.
12032 * Reports an error in an asynchronous function in an idle function by
12033 * directly setting the contents of the #GAsyncResult with the given error
12039 * G_ENUM_CLASS_TYPE:
12040 * @class: a #GEnumClass
12042 * Get the type identifier from a given #GEnumClass structure.
12044 * Returns: the #GType
12051 * The fundamental type corresponding to #gfloat.
12056 * g_async_initable_newv_async:
12057 * @object_type: a #GType supporting #GAsyncInitable.
12058 * @n_parameters: the number of parameters in @parameters
12059 * @parameters: the parameters to use to construct the object
12060 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the operation.
12061 * @cancellable: optional #GCancellable object, %NULL to ignore.
12062 * @callback: a #GAsyncReadyCallback to call when the initialization is finished
12063 * @user_data: the data to pass to callback function
12065 * Helper function for constructing #GAsyncInitiable object. This is
12066 * similar to g_object_newv() but also initializes the object asynchronously.
12067 * When the initialization is finished, @callback will be called. You can
12068 * then call g_async_initable_new_finish() to get the new object and check
12076 * G_VALUE_HOLDS_UCHAR:
12077 * @value: a valid #GValue structure
12079 * Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR.
12081 * Returns: %TRUE on success.
12086 * SECTION:gbufferedoutputstrea:
12087 * @short_description: Buffered Output Stream
12088 * @include: gio/gio.h
12089 * @see_also: #GFilterOutputStream, #GOutputStream
12091 * Buffered output stream implements #GFilterOutputStream and provides
12092 * for buffered writes.
12093 * By default, #GBufferedOutputStream's buffer size is set at 4 kilobytes.
12094 * To create a buffered output stream, use g_buffered_output_stream_new(),
12095 * or g_buffered_output_stream_new_sized() to specify the buffer's size
12097 * To get the size of a buffer within a buffered input stream, use
12098 * g_buffered_output_stream_get_buffer_size(). To change the size of a
12099 * buffered output stream's buffer, use
12100 * g_buffered_output_stream_set_buffer_size(). Note that the buffer's
12101 * size cannot be reduced below the size of the data within the buffer.
12106 * G_SETTINGS_BACKEND_EXTENSION_POINT_NAME:
12108 * Extension point for #GSettingsBackend functionality.
12113 * g_action_group_change_action_state:
12114 * @action_group: a #GActionGroup
12115 * @action_name: the name of the action to request the change on
12116 * @value: the new state
12118 * Request for the state of the named action within @action_group to be
12119 * changed to @value.
12120 * The action must be stateful and @value must be of the correct type.
12121 * See g_action_group_get_state_type().
12122 * This call merely requests a change. The action may refuse to change
12123 * its state or may change its state to something other than @value.
12124 * See g_action_group_get_state_hint().
12125 * If the @value GVariant is floating, it is consumed.
12132 * GMemoryOutputStream:
12134 * Implements #GOutputStream for arbitrary memory chunks.
12140 * @bus_type: A #GBusType.
12141 * @cancellable: A #GCancellable or %NULL.
12142 * @error: Return location for error or %NULL.
12144 * Synchronously connects to the message bus specified by @bus_type.
12145 * Note that the returned object may shared with other callers,
12146 * e.g. if two separate parts of a process calls this function with
12147 * the same @bus_type, they will share the same object.
12148 * This is a synchronous failable function. See g_bus_get() and
12149 * g_bus_get_finish() for the asynchronous version.
12150 * The returned object is a singleton, that is, shared with other
12151 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
12152 * event that you need a private message bus connection, use
12153 * g_dbus_address_get_for_bus_sync() and
12154 * g_dbus_connection_new_for_address().
12155 * Note that the returned #GDBusConnection object will (usually) have
12156 * the #GDBusConnection:exit-on-close property set to %TRUE.
12158 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
12164 * g_file_unmount_mountable:
12165 * @file: input #GFile.
12166 * @flags: flags affecting the operation
12167 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
12168 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
12169 * @user_data: (closure): the data to pass to callback function
12171 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
12172 * If @cancellable is not %NULL, then the operation can be cancelled by
12173 * triggering the cancellable object from another thread. If the operation
12174 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
12175 * When the operation is finished, @callback will be called. You can then call
12176 * g_file_unmount_mountable_finish() to get the result of the operation.
12178 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
12183 * g_network_address_get_port:
12184 * @addr: a #GNetworkAddress
12186 * Gets @addr's port number
12188 * Returns: @addr's port (which may be 0)
12194 * g_dbus_proxy_call:
12195 * @proxy: A #GDBusProxy.
12196 * @method_name: Name of method to invoke.
12197 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
12198 * @flags: Flags from the #GDBusCallFlags enumeration.
12199 * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
12200 * @cancellable: A #GCancellable or %NULL.
12201 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.
12202 * @user_data: The data to pass to @callback.
12204 * Asynchronously invokes the @method_name method on @proxy.
12205 * If @method_name contains any dots, then @name is split into interface and
12206 * method name parts. This allows using @proxy for invoking methods on
12207 * other interfaces.
12208 * If the #GDBusConnection associated with @proxy is closed then
12209 * the operation will fail with %G_IO_ERROR_CLOSED. If
12210 * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
12211 * compatible with the D-Bus protocol, the operation fails with
12212 * %G_IO_ERROR_INVALID_ARGUMENT.
12213 * If the @parameters #GVariant is floating, it is consumed. This allows
12214 * convenient 'inline' use of g_variant_new(), e.g.:
12216 * g_dbus_proxy_call (proxy,
12218 * g_variant_new ("(ss)",
12221 * G_DBUS_CALL_FLAGS_NONE,
12224 * (GAsyncReadyCallback) two_strings_done,
12227 * This is an asynchronous method. When the operation is finished,
12228 * <link linkend="g-main-context-push-thread-default">thread-default
12229 * main loop</link> of the thread you are calling this method from.
12230 * You can then call g_dbus_proxy_call_finish() to get the result of
12231 * the operation. See g_dbus_proxy_call_sync() for the synchronous
12232 * version of this method.
12241 * The fundamental type for #GObject.
12246 * GApplication::open:
12247 * @application: the application
12248 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
12249 * @n_files: the length of @files
12250 * @hint: a hint provided by the calling instance
12252 * The ::open signal is emitted on the primary instance when there are
12253 * files to open. See g_application_open() for more information.
12258 * g_tcp_wrapper_connection_new:
12259 * @base_io_stream: the #GIOStream to wrap
12260 * @socket: the #GSocket associated with @base_io_stream
12262 * Wraps @base_io_stream and @socket together as a #GSocketConnection.
12264 * Returns: the new #GSocketConnection.
12270 * g_dbus_proxy_new_finish:
12271 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().
12272 * @error: Return location for error or %NULL.
12274 * Finishes creating a #GDBusProxy.
12276 * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
12282 * g_socket_client_set_local_address:
12283 * @client: a #GSocketClient.
12284 * @address: a #GSocketAddress, or %NULL
12286 * Sets the local address of the socket client.
12287 * The sockets created by this object will bound to the
12288 * specified address (if not %NULL) before connecting.
12289 * This is useful if you want to ensure the the local
12290 * side of the connection is on a specific port, or on
12291 * a specific interface.
12298 * g_input_stream_has_pending:
12299 * @stream: input stream.
12301 * Checks if an input stream has pending actions.
12303 * Returns: %TRUE if @stream has pending actions.
12308 * GDBusMessageHeaderField:
12309 * @G_DBUS_MESSAGE_HEADER_FIELD_INVALID: Not a valid header field.
12310 * @G_DBUS_MESSAGE_HEADER_FIELD_PATH: The object path.
12311 * @G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE: The interface name.
12312 * @G_DBUS_MESSAGE_HEADER_FIELD_MEMBER: The method or signal name.
12313 * @G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME: The name of the error that occurred.
12314 * @G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL: The serial number the message is a reply to.
12315 * @G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION: The name the message is intended for.
12316 * @G_DBUS_MESSAGE_HEADER_FIELD_SENDER: Unique name of the sender of the message (filled in by the bus).
12317 * @G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE: The signature of the message body.
12318 * @G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS: The number of UNIX file descriptors that accompany the message.
12320 * Header fields used in #GDBusMessage.
12327 * G_PARAM_SPEC_TYPE:
12328 * @pspec: a valid #GParamSpec
12330 * Retrieves the #GType of this @pspec.
12335 * g_dbus_connection_send_message_with_reply:
12336 * @connection: A #GDBusConnection.
12337 * @message: A #GDBusMessage.
12338 * @flags: Flags affecting how the message is sent.
12339 * @timeout_msec: The timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout.
12340 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
12341 * @cancellable: A #GCancellable or %NULL.
12342 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result.
12343 * @user_data: The data to pass to @callback.
12345 * Asynchronously sends @message to the peer represented by @connection.
12346 * Unless @flags contain the
12347 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
12348 * will be assigned by @connection and set on @message via
12349 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
12350 * serial number used will be written to this location prior to
12351 * submitting the message to the underlying transport.
12352 * If @connection is closed then the operation will fail with
12353 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
12354 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
12355 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
12356 * This is an asynchronous method. When the operation is finished, @callback will be invoked
12357 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
12358 * of the thread you are calling this method from. You can then call
12359 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
12360 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
12361 * Note that @message must be unlocked, unless @flags contain the
12362 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
12363 * See <xref linkend="gdbus-server"/> and <xref
12364 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
12365 * low-level API to send and receive UNIX file descriptors.
12372 * g_file_info_get_attribute_byte_string:
12373 * @info: a #GFileInfo.
12374 * @attribute: a file attribute key.
12376 * Gets the value of a byte string attribute. If the attribute does
12377 * not contain a byte string, %NULL will be returned.
12380 * Returns: the contents of the @attribute value as a byte string, or
12385 * g_socket_get_credentials:
12386 * @socket: a #GSocket.
12387 * @error: #GError for error reporting, or %NULL to ignore.
12389 * Returns the credentials of the foreign process connected to this
12390 * socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX
12392 * If this operation isn't supported on the OS, the method fails with
12393 * the %G_IO_ERROR_NOT_SUPPORTED error. On Linux this is implemented
12394 * by reading the %SO_PEERCRED option on the underlying socket.
12395 * Other ways to obtain credentials from a foreign peer includes the
12396 * #GUnixCredentialsMessage type and
12397 * g_unix_connection_send_credentials() /
12398 * g_unix_connection_receive_credentials() functions.
12399 * that must be freed with g_object_unref().
12401 * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object
12407 * G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE:
12409 * A key in the "standard" namespace for getting the amount of disk space
12410 * that is consumed by the file (in bytes). This will generally be larger
12411 * than the file size (due to block size overhead) but can occasionally be
12412 * smaller (for example, for sparse files).
12413 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
12420 * g_node_prepend_data:
12421 * @parent: the #GNode to place the new #GNode under
12422 * @data: the data for the new #GNode
12424 * Inserts a new #GNode as the first child of the given parent.
12426 * Returns: the new #GNode
12431 * GVolumeMonitor::volume-changed:
12432 * @volume_monitor: The volume monitor emitting the signal.
12433 * @volume: a #GVolume that changed.
12435 * Emitted when mountable volume is changed.
12441 * @signal_id: The signal id of the signal being queried, or 0 if the signal to be queried was unknown.
12442 * @signal_name: The signal name.
12443 * @itype: The interface/instance type that this signal can be emitted for.
12444 * @signal_flags: The signal flags as passed in to g_signal_new().
12445 * @return_type: The return type for user callbacks.
12446 * @n_params: The number of parameters that user callbacks take.
12447 * @param_types: The individual parameter types for user callbacks, note that the effective callback signature is: <programlisting> [#param_types param_names,] #gpointer data2); </programlisting>
12449 * A structure holding in-depth information for a specific signal. It is
12450 * filled in by the g_signal_query() function.
12455 * G_DEFINE_ABSTRACT_TYPE:
12456 * @TN: The name of the new type, in Camel case.
12457 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
12458 * @T_P: The #GType of the parent type.
12460 * A convenience macro for type implementations.
12461 * Similar to G_DEFINE_TYPE(), but defines an abstract type.
12462 * See G_DEFINE_TYPE_EXTENDED() for an example.
12469 * g_dbus_proxy_new_for_bus_sync:
12470 * @bus_type: A #GBusType.
12471 * @flags: Flags used when constructing the proxy.
12472 * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
12473 * @name: A bus name (well-known or unique).
12474 * @object_path: An object path.
12475 * @interface_name: A D-Bus interface name.
12476 * @cancellable: A #GCancellable or %NULL.
12477 * @error: Return location for error or %NULL.
12479 * Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection.
12480 * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
12482 * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
12488 * GVolume::changed:
12490 * Emitted when the volume has been changed.
12497 * The fundamental type corresponding to #gchar.
12498 * The type designated by G_TYPE_CHAR is unconditionally an 8-bit signed integer.
12499 * This may or may not be the same type a the C type "gchar".
12504 * g_buffered_output_stream_set_auto_grow:
12505 * @stream: a #GBufferedOutputStream.
12506 * @auto_grow: a #gboolean.
12508 * Sets whether or not the @stream's buffer should automatically grow.
12509 * If @auto_grow is true, then each write will just make the buffer
12510 * larger, and you must manually flush the buffer to actually write out
12511 * the data to the underlying stream.
12516 * g_memory_output_stream_get_size:
12517 * @ostream: a #GMemoryOutputStream
12519 * Gets the size of the currently allocated data area (available from
12520 * g_memory_output_stream_get_data()). If the stream isn't
12521 * growable (no realloc was passed to g_memory_output_stream_new()) then
12522 * this is the maximum size of the stream and further writes
12523 * will return %G_IO_ERROR_NO_SPACE.
12524 * Note that for growable streams the returned size may become invalid on
12525 * the next write or truncate operation on the stream.
12526 * If you want the number of bytes currently written to the stream, use
12527 * g_memory_output_stream_get_data_size().
12529 * Returns: the number of bytes allocated for the data buffer
12534 * GMount::unmounted:
12535 * @mount: the object on which the signal is emitted
12537 * This signal is emitted when the #GMount have been
12538 * unmounted. If the recipient is holding references to the
12539 * object they should release them so the object can be
12546 * @G_BUS_TYPE_STARTER: An alias for the message bus that activated the process, if any.
12547 * @G_BUS_TYPE_NONE: Not a message bus.
12548 * @G_BUS_TYPE_SYSTEM: The system-wide message bus.
12549 * @G_BUS_TYPE_SESSION: The login session message bus.
12551 * An enumeration for well-known message buses.
12558 * GMount::pre-unmount:
12559 * @mount: the object on which the signal is emitted
12561 * This signal is emitted when the #GMount is about to be
12569 * g_dbus_connection_get_guid:
12570 * @connection: A #GDBusConnection.
12572 * The GUID of the peer performing the role of server when
12573 * authenticating. See #GDBusConnection:guid for more details.
12575 * Returns: The GUID. Do not free this string, it is owned by
12581 * g_socket_connection_factory_register_type:
12582 * @g_type: a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION
12583 * @family: a #GSocketFamily
12584 * @type: a #GSocketType
12585 * @protocol: a protocol id
12587 * Looks up the #GType to be used when creating socket connections on
12588 * sockets with the specified @family,@type and @protocol.
12589 * If no type is registered, the #GSocketConnection base type is returned.
12597 * @volume: a #GVolume.
12598 * @flags: flags affecting the operation
12599 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
12600 * @cancellable: optional #GCancellable object, %NULL to ignore.
12601 * @callback: a #GAsyncReadyCallback, or %NULL.
12602 * @user_data: user data that gets passed to @callback
12604 * Mounts a volume. This is an asynchronous operation, and is
12605 * finished by calling g_volume_mount_finish() with the @volume
12606 * and #GAsyncResult returned in the @callback.
12608 * Virtual: mount_fn
12613 * g_unix_mount_point_get_device_path:
12614 * @mount_point: a #GUnixMountPoint.
12616 * Gets the device path for a unix mount point.
12618 * Returns: a string containing the device path.
12623 * g_socket_get_family:
12624 * @socket: a #GSocket.
12626 * Gets the socket family of the socket.
12628 * Returns: a #GSocketFamily
12635 * @g_iface: The parent interface.
12636 * @convert: Converts data.
12637 * @reset: Reverts the internal state of the converter to its initial state.
12639 * Provides an interface for converting data from one type
12640 * to another type. The conversion can be stateful
12641 * and may fail at any place.
12648 * G_FILE_ATTRIBUTE_STANDARD_SIZE:
12650 * A key in the "standard" namespace for getting the file's size (in bytes).
12651 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
12656 * g_app_info_get_executable:
12657 * @appinfo: a #GAppInfo
12659 * Gets the executable's name for the installed application.
12662 * Returns: a string containing the @appinfo's application
12667 * GDBusAuthObserver:
12669 * The #GDBusAuthObserver structure contains only private data and
12670 * should only be accessed using the provided API.
12677 * g_settings_get_value:
12678 * @settings: a #GSettings object
12679 * @key: the key to get the value for
12680 * @returns: a new #GVariant
12682 * Gets the value that is stored in @settings for @key.
12683 * It is a programmer error to give a @key that isn't contained in the
12684 * schema for @settings.
12692 * @parent_instance: private #GParamSpec portion
12693 * @flags_class: the #GFlagsClass for the flags
12694 * @default_value: default value for the property specified
12696 * A #GParamSpec derived structure that contains the meta data for flags
12702 * GTlsAuthenticationMode:
12703 * @G_TLS_AUTHENTICATION_NONE: client authentication not required
12704 * @G_TLS_AUTHENTICATION_REQUESTED: client authentication is requested
12705 * @G_TLS_AUTHENTICATION_REQUIRED: client authentication is required
12707 * The client authentication mode for a #GTlsServerConnection.
12714 * g_dbus_connection_close_finish:
12715 * @connection: A #GDBusConnection.
12716 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close().
12717 * @error: Return location for error or %NULL.
12719 * Finishes an operation started with g_dbus_connection_close().
12721 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
12727 * G_URI_RESERVED_CHARS_GENERIC_DELIMITERS:
12729 * Generic delimiters characters as defined in RFC 3986. Includes ":/?#[]@".
12734 * g_settings_set_value:
12735 * @settings: a #GSettings object
12736 * @key: the name of the key to set
12737 * @value: a #GVariant of the correct type
12738 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
12740 * Sets @key in @settings to @value.
12741 * It is a programmer error to give a @key that isn't contained in the
12742 * schema for @settings or for @value to have the incorrect type, per
12744 * If @value is floating then this function consumes the reference.
12751 * GRegexMatchFlags:
12752 * @G_REGEX_MATCH_ANCHORED: 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 "^" metacharater.
12753 * @G_REGEX_MATCH_NOTBOL: 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 only the behaviour of the circumflex metacharacter, it does not affect "\A".
12754 * @G_REGEX_MATCH_NOTEOL: 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".
12755 * @G_REGEX_MATCH_NOTEMPTY: 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 a string not beginning with "a" or "b", it matches the empty string at the start of the string. With this flag set, this match is not valid, so GRegex searches further into the string for occurrences of "a" or "b".
12756 * @G_REGEX_MATCH_PARTIAL: Turns on the partial matching feature, for more documentation on partial matching see g_match_info_is_partial_match().
12757 * @G_REGEX_MATCH_NEWLINE_CR: Overrides the newline definition set when creating a new #GRegex, setting the '\r' character as line terminator.
12758 * @G_REGEX_MATCH_NEWLINE_LF: Overrides the newline definition set when creating a new #GRegex, setting the '\n' character as line terminator.
12759 * @G_REGEX_MATCH_NEWLINE_CRLF: Overrides the newline definition set when creating a new #GRegex, setting the '\r\n' characters as line terminator.
12760 * @G_REGEX_MATCH_NEWLINE_ANY: Overrides the newline definition set when creating a new #GRegex, any newline character or character sequence is recognized.
12762 * Flags specifying match-time options.
12770 * @G_SOCKET_FAMILY_INVALID: no address family
12771 * @G_SOCKET_FAMILY_IPV4: the IPv4 family
12772 * @G_SOCKET_FAMILY_IPV6: the IPv6 family
12773 * @G_SOCKET_FAMILY_UNIX: the UNIX domain family
12775 * The protocol family of a #GSocketAddress. (These values are
12776 * identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX,
12784 * g_input_stream_close_finish:
12785 * @stream: a #GInputStream.
12786 * @result: a #GAsyncResult.
12787 * @error: a #GError location to store the error occuring, or %NULL to ignore.
12789 * Finishes closing a stream asynchronously, started from g_input_stream_close_async().
12791 * Returns: %TRUE if the stream was closed successfully.
12796 * G_TYPE_IS_CLASSED:
12797 * @type: A #GType value.
12799 * Checks if @type is a classed type.
12801 * Returns: %TRUE on success.
12806 * g_resolver_lookup_by_address_finish:
12807 * @resolver: a #GResolver
12808 * @result: the result passed to your #GAsyncReadyCallback
12809 * @error: return location for a #GError, or %NULL
12811 * Retrieves the result of a previous call to
12812 * g_resolver_lookup_by_address_async().
12813 * If the DNS resolution failed, @error (if non-%NULL) will be set to
12814 * a value from #GResolverError. If the operation was cancelled,
12815 * form), or %NULL on error.
12817 * Returns: a hostname (either ASCII-only, or in ASCII-encoded
12823 * G_TYPE_PARAM_OVERRIDE:
12825 * The #GType of #GParamSpecOverride.
12832 * mime_info_cache_reload:
12833 * @dir: directory path which needs reloading.
12835 * Reload the mime information for the @dir.
12841 * @socket: a #GSocket.
12843 * Returns the underlying OS socket object. On unix this
12844 * is a socket file descriptor, and on windows this is
12845 * a Winsock2 SOCKET handle. This may be useful for
12846 * doing platform specific or otherwise unusual operations
12849 * Returns: the file descriptor of the socket.
12857 * An opaque structure used as the base of all classes.
12862 * GBindingTransformFunc:
12863 * @binding: a #GBinding
12864 * @source_value: the value of the source property
12865 * @target_value: the value of the target property
12866 * @user_data: data passed to the transform function
12868 * A function to be called to transform the source property of @source
12869 * from @source_value into the target property of @target
12870 * using @target_value.
12873 * Returns: %TRUE if the transformation was successful, and %FALSE
12879 * G_PARAM_SPEC_OVERRIDE:
12880 * @pspec: a #GParamSpec
12882 * Casts a #GParamSpec into a #GParamSpecOverride.
12891 * An implementation of #GIcon for icons with emblems.
12896 * GDBusConnection:address:
12898 * A D-Bus address specifying potential endpoints that can be used
12899 * when establishing the connection.
12906 * g_mount_operation_set_choice:
12907 * @op: a #GMountOperation.
12908 * @choice: an integer.
12910 * Sets a default choice for the mount operation.
12915 * g_dbus_message_set_body:
12916 * @message: A #GDBusMessage.
12917 * @body: Either %NULL or a #GVariant that is a tuple.
12919 * Sets the body @message. As a side-effect the
12920 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
12921 * type string of @body (or cleared if @body is %NULL).
12922 * If @body is floating, @message assumes ownership of @body.
12929 * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
12931 * The string used to obtain a NFS mount with g_volume_get_identifier().
12937 * @value: the flags value
12938 * @value_name: the name of the value
12939 * @value_nick: the nickname of the value
12941 * A structure which contains a single flags value, its name, and its
12947 * g_data_input_stream_read_upto_async:
12948 * @stream: a #GDataInputStream
12949 * @stop_chars: characters to terminate the read
12950 * @stop_chars_len: length of @stop_chars. May be -1 if @stop_chars is nul-terminated
12951 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
12952 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
12953 * @callback: (scope async): callback to call when the request is satisfied
12954 * @user_data: (closure): the data to pass to callback function
12956 * The asynchronous version of g_data_input_stream_read_upto().
12957 * It is an error to have two outstanding calls to this function.
12958 * In contrast to g_data_input_stream_read_until(), this function
12959 * does <emphasis>not</emphasis> consume the stop character. You have
12960 * to use g_data_input_stream_read_byte() to get it before calling
12961 * g_data_input_stream_read_upto() again.
12962 * Note that @stop_chars may contain '\0' if @stop_chars_len is
12964 * When the operation is finished, @callback will be called. You
12965 * can then call g_data_input_stream_read_upto_finish() to get
12966 * the result of the operation.
12973 * g_tls_certificate_verify:
12974 * @cert: a #GTlsCertificate
12975 * @identity: (allow-none): the expected peer identity
12976 * @trusted_ca: (allow-none): the certificate of a trusted authority
12978 * This verifies @cert and returns a set of #GTlsCertificateFlags
12979 * indicating any problems found with it. This can be used to verify a
12980 * certificate outside the context of making a connection, or to
12981 * check a certificate against a CA that is not part of the system
12983 * If @identity is not %NULL, @cert's name(s) will be compared against
12984 * it, and %G_TLS_CERTIFICATE_BAD_IDENTITY will be set in the return
12985 * value if it does not match. If @identity is %NULL, that bit will
12986 * never be set in the return value.
12987 * If @trusted_ca is not %NULL, then @cert (or one of the certificates
12988 * in its chain) must be signed by it, or else
12989 * %G_TLS_CERTIFICATE_UNKNOWN_CA will be set in the return value. If
12991 * (All other #GTlsCertificateFlags values will always be set or unset
12994 * Returns: the appropriate #GTlsCertificateFlags
13000 * g_application_set_application_id:
13001 * @application: a #GApplication
13002 * @application_id: the identifier for @application
13004 * Sets the unique identifier for @application.
13005 * The application id can only be modified if @application has not yet
13007 * The application id must be valid. See g_application_id_is_valid().
13014 * GCredentialsType:
13015 * @G_CREDENTIALS_TYPE_INVALID: Indicates an invalid native credential type.
13016 * @G_CREDENTIALS_TYPE_LINUX_UCRED: The native credentials type is a <type>struct ucred</type>.
13017 * @G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED: The native credentials type is a <type>struct cmsgcred</type>.
13019 * Enumeration describing different kinds of native credential types.
13028 * A helper class for network servers to listen for and accept connections.
13035 * g_dbus_method_invocation_get_object_path:
13036 * @invocation: A #GDBusMethodInvocation.
13038 * Gets the object path the method was invoked on.
13040 * Returns: A string. Do not free, it is owned by @invocation.
13046 * g_application_open:
13047 * @application: a #GApplication
13048 * @files: (array length=n_files): an array of #GFiles to open
13049 * @n_files: the length of the @files array
13050 * @hint: a hint (or ""), but never %NULL
13052 * Opens the given files.
13053 * In essence, this results in the #GApplication::open signal being emitted
13054 * in the primary instance.
13055 * intended to be used by applications that have multiple modes for
13056 * for this functionality, you should use "".
13057 * The application must be registered before calling this function
13058 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
13060 * Opening files (eg: "view" vs "edit", etc). Unless you have a need
13068 * Error domain for character set conversions. Errors in this domain will
13069 * be from the #GConvertError enumeration. See #GError for information on
13075 * g_file_append_to_finish:
13076 * @file: input #GFile.
13077 * @res: #GAsyncResult
13078 * @error: a #GError, or %NULL
13080 * Finishes an asynchronous file append operation started with
13081 * g_file_append_to_async().
13082 * Free the returned object with g_object_unref().
13084 * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error.
13089 * g_dbus_is_address:
13090 * @string: A string.
13092 * Checks if @string is a D-Bus address.
13093 * This doesn't check if @string is actually supported by #GDBusServer
13094 * or #GDBusConnection - use g_dbus_is_supported_address() to do more
13097 * Returns: %TRUE if @string is a valid D-Bus address, %FALSE otherwise.
13103 * g_dbus_message_get_flags:
13104 * @message: A #GDBusMessage.
13106 * Gets the flags for @message.
13108 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
13114 * g_dbus_arg_info_unref:
13115 * @info: A #GDBusArgInfo.
13117 * If @info is statically allocated, does nothing. Otherwise decreases
13118 * the reference count of @info. When its reference count drops to 0,
13119 * the memory used is freed.
13126 * g_mount_operation_new:
13128 * Creates a new mount operation.
13130 * Returns: a #GMountOperation.
13135 * GSimpleAction:state-type:
13137 * The #GVariantType of the state that the action has, or %NULL if the
13138 * action is stateless.
13145 * G_TYPE_CHECK_CLASS_TYPE:
13146 * @g_class: Location of a #GTypeClass structure.
13147 * @g_type: The type to be checked.
13149 * Checks if @g_class is a class structure of the type identified by
13150 * This macro should only be used in type implementations.
13152 * Returns: %TRUE on success.
13157 * g_io_modules_load_all_in_directory:
13158 * @dirname: pathname for a directory containing modules to load.
13160 * Loads all the modules in the specified directory.
13161 * If don't require all modules to be initialized (and thus registering
13162 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
13163 * which allows delayed/lazy loading of modules.
13164 * from the directory,
13165 * All the modules are loaded into memory, if you want to
13166 * unload them (enabling on-demand loading) you must call
13167 * g_type_module_unuse() on all the modules. Free the list
13168 * with g_list_free().
13170 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
13175 * g_unix_connection_receive_credentials:
13176 * @connection: A #GUnixConnection.
13177 * @cancellable: (allow-none): A #GCancellable or %NULL.
13178 * @error: Return location for error or %NULL.
13180 * Receives credentials from the sending end of the connection. The
13181 * sending end has to call g_unix_connection_send_credentials() (or
13182 * similar) for this to work.
13183 * As well as reading the credentials this also reads (and discards) a
13184 * single byte from the stream, as this is required for credentials
13185 * passing to work on some implementations.
13186 * Other ways to exchange credentials with a foreign peer includes the
13187 * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
13188 * g_object_unref()), %NULL if @error is set.
13190 * Returns: (transfer full): Received credentials on success (free with
13196 * g_proxy_resolver_lookup_finish:
13197 * @resolver: a #GProxyResolver
13198 * @result: the result passed to your #GAsyncReadyCallback
13199 * @error: return location for a #GError, or %NULL
13201 * Call this function to obtain the array of proxy URIs when
13202 * g_proxy_resolver_lookup_async() is complete. See
13203 * g_proxy_resolver_lookup() for more details.
13204 * NULL-terminated array of proxy URIs. Must be freed
13205 * with g_strfreev().
13207 * Returns: (transfer full) (array zero-terminated=1): A
13213 * g_dbus_message_set_error_name:
13214 * @message: A #GDBusMessage.
13215 * @value: The value to set.
13217 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
13224 * g_socket_client_connect_async:
13225 * @client: a #GTcpClient
13226 * @connectable: a #GSocketConnectable specifying the remote address.
13227 * @cancellable: (allow-none): a #GCancellable, or %NULL
13228 * @callback: (scope async): a #GAsyncReadyCallback
13229 * @user_data: (closure): user data for the callback
13231 * This is the asynchronous version of g_socket_client_connect().
13232 * When the operation is finished @callback will be
13233 * called. You can then call g_socket_client_connect_finish() to get
13234 * the result of the operation.
13241 * g_io_module_unload:
13242 * @module: a #GIOModule.
13244 * Required API for GIO modules to implement.
13245 * This function is ran when the module is being unloaded from GIO,
13246 * to finalize the module.
13253 * The object that handles DNS resolution. Use g_resolver_get_default()
13254 * to get the default resolver.
13259 * GDBusConnection:guid:
13261 * The GUID of the peer performing the role of server when
13263 * If you are constructing a #GDBusConnection and pass
13264 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
13265 * #GDBusConnection:flags property then you MUST also set this
13266 * property to a valid guid.
13267 * If you are constructing a #GDBusConnection and pass
13268 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
13269 * #GDBusConnection:flags property you will be able to read the GUID
13270 * of the other peer here after the connection has been successfully
13278 * g_inet_address_new_from_string:
13279 * @string: a string representation of an IP address
13281 * Parses @string as an IP address and creates a new #GInetAddress.
13283 * Returns: a new #GInetAddress corresponding to @string, or %NULL if
13289 * g_app_info_get_id:
13290 * @appinfo: a #GAppInfo.
13292 * Gets the ID of an application. An id is a string that
13293 * identifies the application. The exact format of the id is
13294 * platform dependent. For instance, on Unix this is the
13295 * desktop file id from the xdg menu specification.
13296 * Note that the returned ID may be %NULL, depending on how
13297 * the @appinfo has been constructed.
13299 * Returns: a string containing the application's ID.
13306 * Class for providing authentication methods for mounting operations,
13307 * such as mounting a file locally, or authenticating with a server.
13312 * g_dbus_message_new_method_error_literal:
13313 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to.
13314 * @error_name: A valid D-Bus error name.
13315 * @error_message: The D-Bus error message.
13317 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
13319 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
13325 * GTlsCertificate:certificate:
13327 * The DER (binary) encoded representation of the certificate's
13328 * public key. This property and the
13329 * #GTlsCertificate:certificate-pem property represent the same
13330 * data, just in different forms.
13337 * G_VALUE_HOLDS_FLOAT:
13338 * @value: a valid #GValue structure
13340 * Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT.
13342 * Returns: %TRUE on success.
13347 * g_dbus_node_info_lookup_interface:
13348 * @info: A #GDBusNodeInfo.
13349 * @name: A D-Bus interface name.
13351 * Looks up information about an interface.
13352 * This cost of this function is O(n) in number of interfaces.
13354 * Returns: A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info.
13360 * g_data_output_stream_put_int64:
13361 * @stream: a #GDataOutputStream.
13362 * @data: a #gint64.
13363 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
13364 * @error: a #GError, %NULL to ignore.
13366 * Puts a signed 64-bit integer into the stream.
13368 * Returns: %TRUE if @data was successfully added to the @stream.
13373 * g_output_stream_close:
13374 * @stream: A #GOutputStream.
13375 * @cancellable: (allow-none): optional cancellable object
13376 * @error: location to store the error occuring, or %NULL to ignore
13378 * Closes the stream, releasing resources related to it.
13379 * Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
13380 * Closing a stream multiple times will not return an error.
13381 * Closing a stream will automatically flush any outstanding buffers in the
13383 * Streams will be automatically closed when the last reference
13384 * is dropped, but you might want to call this function to make sure
13385 * resources are released as early as possible.
13386 * Some streams might keep the backing store of the stream (e.g. a file descriptor)
13387 * open after the stream is closed. See the documentation for the individual
13388 * stream for details.
13389 * On failure the first error that happened will be reported, but the close
13390 * operation will finish as much as possible. A stream that failed to
13391 * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
13392 * is important to check and report the error to the user, otherwise
13393 * there might be a loss of data as all data might not be written.
13394 * If @cancellable is not NULL, then the operation can be cancelled by
13395 * triggering the cancellable object from another thread. If the operation
13396 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13397 * Cancelling a close will still leave the stream closed, but there some streams
13398 * can use a faster close that doesn't block to e.g. check errors. On
13399 * cancellation (as with any error) there is no guarantee that all written
13400 * data will reach the target.
13402 * Returns: %TRUE on success, %FALSE on failure
13407 * g_win32_output_stream_get_handle:
13408 * @stream: a #GWin32OutputStream
13410 * Return the Windows handle that the stream writes to.
13412 * Returns: The handle descriptor of @stream
13418 * g_socket_connectable_enumerate:
13419 * @connectable: a #GSocketConnectable
13421 * Creates a #GSocketAddressEnumerator for @connectable.
13423 * Returns: (transfer full): a new #GSocketAddressEnumerator.
13429 * The string info map is an efficient data structure designed to b:
13431 * used with a small set of items. It is used by GSettings schemas for
13433 * 1) Implement <choices> with a list of valid strings
13434 * 2) Implement <alias> by mapping one string to another
13435 * 3) Implement enumerated types by mapping strings to integer values
13437 * The map is made out of an array of uint32s. Each entry in the array
13438 * is an integer value, followed by a specially formatted string value:
13439 * The string starts with the byte 0xff or 0xfe, followed by the
13440 * content of the string, followed by a nul byte, followed by
13441 * additional nul bytes for padding, followed by a 0xff byte.
13442 * Padding is added so that the entire formatted string takes up a
13443 * multiple of 4 bytes, and not less than 8 bytes. The requirement
13444 * for a string to take up 8 bytes is so that the scanner doesn't lose
13445 * synch and mistake a string for an integer value.
13446 * The first byte of the formatted string depends on if the integer is
13447 * an enum value (0xff) or an alias (0xfe). If it is an alias then the
13448 * number refers to the word offset within the info map at which the
13449 * integer corresponding to the "target" value is stored.
13450 * For example, consider the case of the string info map representing an
13451 * enumerated type of 'foo' (value 1) and 'bar' (value 2) and 'baz'
13452 * (alias for 'bar'). Note that string info maps are always little
13454 * x01 x00 x00 x00 xff 'f' 'o' 'o' x00 x00 x00 xff x02 x00 x00 x00
13455 * xff 'b' 'a' 'r' x00 x00 x00 xff x03 x00 x00 x00 xfe 'b' 'a' 'z'
13457 * The operations that someone may want to perform with the map:
13458 * - lookup if a string is valid (and not an alias)
13459 * - lookup the integer value for a enum 'nick'
13460 * - lookup the integer value for the target of an alias
13461 * - lookup an alias and convert it to its target string
13462 * - lookup the enum nick for a given value
13463 * In order to lookup if a string is valid, it is padded on either side
13464 * (as described) and scanned for in the array. For example, you might
13466 * xff 'f' 'o' 'o' x00 x00 x00 xff
13467 * In order to lookup the integer value for a nick, the string is padded
13468 * on either side and scanned for in the array, as above. Instead of
13469 * merely succeeding, we look at the integer value to the left of the
13470 * match. This is the enum value.
13471 * In order to lookup an alias and convert it to its target enum value,
13472 * the string is padded on either side (as described, with 0xfe) and
13473 * scanned for. For example, you might look for "baz":
13474 * xfe 'b' 'a' 'z' x00 x00 x00 xff
13475 * The integer immediately preceeding the match then contains the offset
13476 * of the integer value of the target. In our example, that's '3'.
13477 * This index is dereferenced to find the enum value of '2'.
13478 * To convert the alias to its target string, 5 bytes just need to be
13479 * added past the start of the integer value to find the start of the
13481 * To lookup the enum nick for a given value, the value is searched for
13482 * in the array. To ensure that the value isn't matching the inside of a
13483 * string, we must check that it is either the first item in the array or
13484 * immediately preceeded by the byte 0xff. It must also be immediately
13485 * followed by the byte 0xff.
13486 * Because strings always take up a minimum of 2 words, because 0xff or
13487 * 0xfe never appear inside of a utf-8 string and because no two integer
13488 * values ever appear in sequence, the only way we can have the
13490 * xff __ __ __ __ xff (or 0xfe)
13491 * is in the event of an integer nested between two strings.
13492 * For implementation simplicity/efficiency, strings may not be more
13493 * the value of each choice is set to zero and ignored.
13495 * Than 65 characters in length (ie: 17 32bit words after padding).
13496 * In the event that we are doing <choices> (ie: not an enum type) then
13501 * g_settings_get_string:
13502 * @settings: a #GSettings object
13503 * @key: the key to get the value for
13504 * @returns: a newly-allocated string
13506 * Gets the value that is stored at @key in @settings.
13507 * A convenience variant of g_settings_get() for strings.
13508 * It is a programmer error to give a @key that isn't specified as
13509 * having a string type in the schema for @settings.
13517 * @closure: the #GClosure
13518 * @callback: the callback function
13520 * A #GCClosure is a specialization of #GClosure for C function callbacks.
13525 * GWin32InputStream:
13527 * Implements #GInputStream for reading from selectable Windows file handles
13532 * g_settings_get_boolean:
13533 * @settings: a #GSettings object
13534 * @key: the key to get the value for
13535 * @returns: a boolean
13537 * Gets the value that is stored at @key in @settings.
13538 * A convenience variant of g_settings_get() for booleans.
13539 * It is a programmer error to give a @key that isn't specified as
13540 * having a boolean type in the schema for @settings.
13547 * g_desktop_app_info_launch_uris_as_manager:
13548 * @appinfo: a #GDesktopAppInfo
13549 * @uris: (element-type utf8): List of URIs
13550 * @launch_context: a #GAppLaunchContext
13551 * @spawn_flags: #GSpawnFlags, used for each process
13552 * @user_setup: (scope call): a #GSpawnChildSetupFunc, used once for each process.
13553 * @user_setup_data: (closure user_setup): User data for @user_setup
13554 * @pid_callback: (scope call): Callback for child processes
13555 * @pid_callback_data: (closure pid_callback): User data for @callback
13556 * @error: a #GError
13558 * This function performs the equivalent of g_app_info_launch_uris(),
13559 * but is intended primarily for operating system components that
13560 * launch applications. Ordinary applications should use
13561 * g_app_info_launch_uris().
13562 * In contrast to g_app_info_launch_uris(), all processes created will
13563 * always be run directly as children as if by the UNIX fork()/exec()
13565 * This guarantee allows additional control over the exact environment
13566 * of the child processes, which is provided via a setup function
13567 * semantics of the @setup function.
13572 * g_signal_connect_swapped:
13573 * @instance: the instance to connect to.
13574 * @detailed_signal: a string of the form "signal-name::detail".
13575 * @c_handler: the #GCallback to connect.
13576 * @data: data to pass to @c_handler calls.
13578 * Connects a #GCallback function to a signal for a particular object.
13579 * The instance on which the signal is emitted and @data will be swapped when
13580 * calling the handler.
13582 * Returns: the handler id
13587 * g_dbus_connection_signal_unsubscribe:
13588 * @connection: A #GDBusConnection.
13589 * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
13591 * Unsubscribes from signals.
13598 * g_emblemed_icon_clear_emblems:
13599 * @emblemed: a #GEmblemedIcon
13601 * Removes all the emblems from @icon.
13610 * Error domain for errors generated by a remote message bus. Errors
13611 * in this domain will be from the #GDBusError enumeration. See
13612 * #GError for more information on error domains.
13613 * Note that errors in this error domain is intended only for
13614 * returning errors from a remote message bus process. Errors
13615 * generated locally in-process by e.g. #GDBusConnection is from the
13616 * %G_IO_ERROR domain.
13623 * GSocketControlMessage:
13625 * Base class for socket-type specific control messages that can be sent and
13626 * received over #GSocket.
13631 * G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK:
13633 * A key in the "standard" namespace for checking if the file is a symlink.
13634 * Typically the actual type is something else, if we followed the symlink
13636 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
13641 * g_dbus_message_set_flags:
13642 * @message: A #GDBusMessage.
13643 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
13645 * Sets the flags to set on @message.
13652 * g_file_append_to_async:
13653 * @file: input #GFile.
13654 * @flags: a set of #GFileCreateFlags.
13655 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
13656 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
13657 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
13658 * @user_data: (closure): the data to pass to callback function
13660 * Asynchronously opens @file for appending.
13661 * For more details, see g_file_append_to() which is
13662 * the synchronous version of this call.
13663 * When the operation is finished, @callback will be called. You can then call
13664 * g_file_append_to_finish() to get the result of the operation.
13671 * Defines a Unix mount entry (e.g. <filename>/media/cdrom</filename>).
13672 * This corresponds roughly to a mtab entry.
13677 * g_dbus_message_set_sender:
13678 * @message: A #GDBusMessage.
13679 * @value: The value to set.
13681 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
13688 * SECTION:gtlsserverconnectio:
13689 * @short_description: TLS server-side connection
13690 * @include: gio/gio.h
13692 * #GTlsServerConnection is the server-side subclass of #GTlsConnection,
13693 * representing a server-side TLS connection.
13700 * g_dbus_proxy_call_sync:
13701 * @proxy: A #GDBusProxy.
13702 * @method_name: Name of method to invoke.
13703 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
13704 * @flags: Flags from the #GDBusCallFlags enumeration.
13705 * @timeout_msec: The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.
13706 * @cancellable: A #GCancellable or %NULL.
13707 * @error: Return location for error or %NULL.
13709 * Synchronously invokes the @method_name method on @proxy.
13710 * If @method_name contains any dots, then @name is split into interface and
13711 * method name parts. This allows using @proxy for invoking methods on
13712 * other interfaces.
13713 * If the #GDBusConnection associated with @proxy is disconnected then
13714 * the operation will fail with %G_IO_ERROR_CLOSED. If
13715 * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
13716 * compatible with the D-Bus protocol, the operation fails with
13717 * %G_IO_ERROR_INVALID_ARGUMENT.
13718 * If the @parameters #GVariant is floating, it is consumed. This allows
13719 * convenient 'inline' use of g_variant_new(), e.g.:
13721 * g_dbus_proxy_call_sync (proxy,
13723 * g_variant_new ("(ss)",
13726 * G_DBUS_CALL_FLAGS_NONE,
13731 * The calling thread is blocked until a reply is received. See
13732 * g_dbus_proxy_call() for the asynchronous version of this
13734 * return values. Free with g_variant_unref().
13736 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
13742 * GDBusProxy:g-object-path:
13744 * The object path the proxy is for.
13751 * G_TYPE_FROM_INSTANCE:
13752 * @instance: Location of a valid #GTypeInstance structure.
13754 * Get the type identifier from a given @instance structure.
13755 * This macro should only be used in type implementations.
13757 * Returns: the #GType
13762 * g_file_info_set_is_symlink:
13763 * @info: a #GFileInfo.
13764 * @is_symlink: a #gboolean.
13766 * Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink.
13767 * See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK.
13772 * G_IS_PARAM_SPEC_DOUBLE:
13773 * @pspec: a valid #GParamSpec instance
13775 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE.
13777 * Returns: %TRUE on success.
13782 * G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE:
13784 * A key in the "access" namespace for checking deletion privileges.
13785 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
13786 * This attribute will be %TRUE if the user is able to delete the file.
13791 * g_file_info_set_attribute_mask:
13792 * @info: a #GFileInfo.
13793 * @mask: a #GFileAttributeMatcher.
13795 * Sets @mask on @info to match specific attribute types.
13802 * Base class for read-write streams.
13808 * @G_SOCKET_MSG_NONE: No flags.
13809 * @G_SOCKET_MSG_OOB: Request to send/receive out of band data.
13810 * @G_SOCKET_MSG_PEEK: Read data from the socket without removing it from the queue.
13811 * @G_SOCKET_MSG_DONTROUTE: Don't use a gateway to send out the packet, only send to hosts on directly connected networks.
13813 * Flags used in g_socket_receive_message() and g_socket_send_message().
13814 * The flags listed in the enum are some commonly available flags, but the
13815 * values used for them are the same as on the platform, and any other flags
13816 * are passed in/out as is. So to use a platform specific flag, just include
13817 * the right system header and pass in the flag.
13824 * g_dbus_is_member_name:
13825 * @string: The string to check.
13827 * Checks if @string is a valid D-Bus member (e.g. signal or method) name.
13829 * Returns: %TRUE if valid, %FALSE otherwise.
13835 * G_TYPE_PARAM_ULONG:
13837 * The #GType of #GParamSpecULong.
13842 * g_file_query_default_handler:
13843 * @file: a #GFile to open.
13844 * @cancellable: optional #GCancellable object, %NULL to ignore.
13845 * @error: a #GError, or %NULL
13847 * Returns the #GAppInfo that is registered as the default
13848 * application to handle the file specified by @file.
13849 * If @cancellable is not %NULL, then the operation can be cancelled by
13850 * triggering the cancellable object from another thread. If the operation
13851 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
13852 * When you are done with it, release it with g_object_unref()
13854 * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors.
13859 * GDBusProxy:g-bus-type:
13861 * If this property is not %G_BUS_TYPE_NONE, then
13862 * #GDBusProxy:g-connection must be %NULL and will be set to the
13863 * #GDBusConnection obtained by calling g_bus_get() with the value
13864 * of this property.
13871 * g_dbus_connection_get_peer_credentials:
13872 * @connection: A #GDBusConnection.
13874 * Gets the credentials of the authenticated peer. This will always
13875 * return %NULL unless @connection acted as a server
13876 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
13877 * when set up and the client passed credentials as part of the
13878 * authentication process.
13879 * In a message bus setup, the message bus is always the server and
13880 * each application is a client. So this method will always return
13881 * %NULL for message bus clients.
13882 * this object, it is owned by @connection.
13884 * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free
13890 * G_FILE_ATTRIBUTE_UNIX_INODE:
13892 * A key in the "unix" namespace for getting the inode of the file.
13893 * This attribute is only available for UNIX file systems. Corresponding
13894 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
13899 * g_file_info_set_icon:
13900 * @info: a #GFileInfo.
13903 * Sets the icon for a given #GFileInfo.
13904 * See %G_FILE_ATTRIBUTE_STANDARD_ICON.
13909 * g_socket_new_from_fd:
13910 * @fd: a native socket file descriptor.
13911 * @error: #GError for error reporting, or %NULL to ignore.
13913 * Creates a new #GSocket from a native file descriptor
13914 * or winsock SOCKET handle.
13915 * This reads all the settings from the file descriptor so that
13916 * all properties should work. Note that the file descriptor
13917 * will be set to non-blocking mode, independent on the blocking
13918 * mode of the #GSocket.
13919 * Free the returned object with g_object_unref().
13921 * Returns: a #GSocket or %NULL on error.
13927 * g_app_launch_context_launch_failed:
13928 * @context: a #GAppLaunchContext.
13929 * @startup_notify_id: the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().
13931 * Called when an application has failed to launch, so that it can cancel
13932 * the application startup notification started in g_app_launch_context_get_startup_notify_id().
13937 * G_VARIANT_TYPE_MAYBE:
13939 * An indefinite type that is a supertype of every maybe type.
13944 * g_socket_get_blocking:
13945 * @socket: a #GSocket.
13947 * Gets the blocking mode of the socket. For details on blocking I/O,
13948 * see g_socket_set_blocking().
13950 * Returns: %TRUE if blocking I/O is used, %FALSE otherwise.
13956 * G_FILE_ATTRIBUTE_THUMBNAIL_PATH:
13958 * A key in the "thumbnail" namespace for getting the path to the thumbnail
13959 * image. Corresponding #GFileAttributeType is
13960 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
13965 * g_buffered_input_stream_set_buffer_size:
13966 * @stream: a #GBufferedInputStream
13969 * Sets the size of the internal buffer of @stream to @size, or to the
13970 * size of the contents of the buffer. The buffer can never be resized
13971 * smaller than its current contents.
13976 * g_action_group_action_enabled_changed:
13977 * @action_group: a #GActionGroup
13978 * @action_name: the name of an action in the group
13979 * @enabled: whether or not the action is now enabled
13981 * Emits the #GActionGroup::action-enabled-changed signal on @action_group.
13982 * This function should only be called by #GActionGroup implementations.
13989 * g_input_stream_read:
13990 * @stream: a #GInputStream.
13991 * @buffer: a buffer to read data into (which should be at least count bytes long).
13992 * @count: the number of bytes that will be read from the stream
13993 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
13994 * @error: location to store the error occuring, or %NULL to ignore
13996 * Tries to read @count bytes from the stream into the buffer starting at
13997 * If count is zero returns zero and does nothing. A value of @count
13998 * larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
13999 * On success, the number of bytes read into the buffer is returned.
14000 * It is not an error if this is not the same as the requested size, as it
14001 * can happen e.g. near the end of a file. Zero is returned on end of file
14002 * (or if @count is zero), but never otherwise.
14003 * If @cancellable is not NULL, then the operation can be cancelled by
14004 * triggering the cancellable object from another thread. If the operation
14005 * was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an
14006 * operation was partially finished when the operation was cancelled the
14007 * partial result will be returned, without an error.
14008 * On error -1 is returned and @error is set accordingly.
14010 * Returns: Number of bytes read, or -1 on error
14015 * g_themed_icon_prepend_name:
14016 * @icon: a #GThemedIcon
14017 * @iconname: name of icon to prepend to list of icons from within @icon.
14019 * Prepend a name to the list of icons from within @icon.
14021 * Note that doing so invalidates the hash computed by prior calls
14022 * to g_icon_hash().
14030 * SECTION:gconverte:
14031 * @short_description: Data conversion interface
14032 * @include: gio/gio.h
14033 * @see_also: #GInputStream, #GOutputStream
14035 * #GConverter is implemented by objects that convert
14036 * binary data in various ways. The conversion can be
14037 * stateful and may fail at any place.
14038 * compression, decompression and regular expression
14041 * Some example conversions are: character set conversion,
14047 * G_TYPE_CHECK_VALUE_TYPE:
14048 * @value: a #GValue
14049 * @g_type: The type to be checked.
14051 * Checks if @value has been initialized to hold values
14053 * This macro should only be used in type implementations.
14055 * Returns: %TRUE on success.
14060 * g_settings_get_enum:
14061 * @settings: a #GSettings object
14062 * @key: the key to get the value for
14063 * @returns: the enum value
14065 * Gets the value that is stored in @settings for @key and converts it
14066 * to the enum value that it represents.
14067 * In order to use this function the type of the value must be a string
14068 * and it must be marked in the schema file as an enumerated type.
14069 * It is a programmer error to give a @key that isn't contained in the
14070 * schema for @settings or is not marked as an enumerated type.
14071 * If the value stored in the configuration database is not a valid
14072 * value for the enumerated type then this function will return the
14080 * G_VOLUME_MONITOR_EXTENSION_POINT_NAME:
14082 * Extension point for volume monitor functionality.
14083 * See <link linkend="extending-gio">Extending GIO</link>.
14088 * g_app_info_reset_type_associations:
14089 * @content_type: a content type
14091 * Removes all changes to the type associations done by
14092 * g_app_info_set_as_default_for_type(),
14093 * g_app_info_set_as_default_for_extension(),
14094 * g_app_info_add_supports_type() or g_app_info_remove_supports_type().
14101 * g_dbus_proxy_get_name:
14102 * @proxy: A #GDBusProxy.
14104 * Gets the name that @proxy was constructed for.
14106 * Returns: A string owned by @proxy. Do not free.
14112 * g_file_info_get_name:
14113 * @info: a #GFileInfo.
14115 * Gets the name for a file.
14117 * Returns: a string containing the file name.
14122 * g_mount_operation_get_anonymous:
14123 * @op: a #GMountOperation.
14125 * Check to see whether the mount operation is being used
14126 * for an anonymous user.
14128 * Returns: %TRUE if mount operation is anonymous.
14133 * g_socket_is_connected:
14134 * @socket: a #GSocket.
14136 * Check whether the socket is connected. This is only useful for
14137 * connection-oriented sockets.
14139 * Returns: %TRUE if socket is connected, %FALSE otherwise.
14145 * g_application_hold:
14146 * @application: a #GApplication
14148 * Increases the use count of @application.
14149 * Use this function to indicate that the application has a reason to
14150 * continue to run. For example, g_application_hold() is called by GTK+
14151 * when a toplevel window is on the screen.
14152 * To cancel the hold, call g_application_release().
14158 * @g_type_class: the parent class
14159 * @value_type: the #GValue type for this parameter
14160 * @finalize: The instance finalization function (optional), should chain up to the finalize method of the parent class.
14161 * @value_set_default: Resets a @value to the default value for this type (recommended, the default is g_value_reset()), see g_param_value_set_default().
14162 * @value_validate: Ensures that the contents of @value comply with the specifications set out by this type (optional), see g_param_value_set_validate().
14163 * @values_cmp: Compares @value1 with @value2 according to this type (recommended, the default is memcmp()), see g_param_values_cmp().
14165 * The class structure for the <structname>GParamSpec</structname> type.
14166 * Normally, <structname>GParamSpec</structname> classes are filled by
14167 * g_param_type_register_static().
14172 * g_socket_get_remote_address:
14173 * @socket: a #GSocket.
14174 * @error: #GError for error reporting, or %NULL to ignore.
14176 * Try to get the remove address of a connected socket. This is only
14177 * useful for connection oriented sockets that have been connected.
14178 * Free the returned object with g_object_unref().
14180 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
14187 * @parent_instance: private #GParamSpec portion
14188 * @is_a_type: a #GType whose subtypes can occur as values
14190 * A #GParamSpec derived structure that contains the meta data for #GType properties.
14197 * g_dbus_message_new_method_reply:
14198 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to.
14200 * Creates a new #GDBusMessage that is a reply to @method_call_message.
14202 * Returns: (transfer full): #GDBusMessage. Free with g_object_unref().
14208 * g_application_register:
14209 * @application: a #GApplication
14210 * @cancellable: a #GCancellable, or %NULL
14211 * @error: a pointer to a NULL #GError, or %NULL
14212 * @returns: %TRUE if registration succeeded
14214 * Attempts registration of the application.
14215 * This is the point at which the application discovers if it is the
14216 * primary instance or merely acting as a remote for an already-existing
14217 * primary instance.
14218 * If the application has already been registered then %TRUE is
14219 * returned with no work performed.
14220 * The #GApplication::startup signal is emitted if registration succeeds
14221 * and @application is the primary instance.
14222 * In the event of an error (such as @cancellable being cancelled, or a
14223 * failure to connect to the session bus), %FALSE is returned and @error
14224 * is set appropriately.
14225 * instance is or is not the primary instance of the application. See
14226 * g_application_get_is_remote() for that.
14228 * Note: the return value of this function is not an indicator that this
14234 * g_emblemed_icon_get_icon:
14235 * @emblemed: a #GEmblemedIcon
14237 * Gets the main icon for @emblemed.
14239 * Returns: (transfer none): a #GIcon that is owned by @emblemed
14245 * g_signal_connect:
14246 * @instance: the instance to connect to.
14247 * @detailed_signal: a string of the form "signal-name::detail".
14248 * @c_handler: the #GCallback to connect.
14249 * @data: data to pass to @c_handler calls.
14251 * Connects a #GCallback function to a signal for a particular object.
14252 * The handler will be called before the default handler of the signal.
14254 * Returns: the handler id
14259 * g_file_info_set_attribute_object:
14260 * @info: a #GFileInfo.
14261 * @attribute: a file attribute key.
14262 * @attr_value: a #GObject.
14264 * Sets the @attribute to contain the given @attr_value,
14271 * @data: Callback data passed to g_object_add_toggle_ref()
14272 * @object: The object on which g_object_add_toggle_ref() was called.
14273 * @is_last_ref: %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.
14275 * A callback function used for notification when the state
14276 * of a toggle reference changes. See g_object_add_toggle_ref().
14281 * G_TYPE_PARAM_INT64:
14283 * The #GType of #GParamSpecInt64.
14288 * GDBusServer:authentication-observer:
14290 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
14297 * GTlsConnection:certificate:
14299 * The connection's certificate; see
14300 * g_tls_connection_set_certificate().
14307 * g_bus_watch_name_on_connection:
14308 * @connection: A #GDBusConnection.
14309 * @name: The name (well-known or unique) to watch.
14310 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
14311 * @name_appeared_handler: Handler to invoke when @name is known to exist or %NULL.
14312 * @name_vanished_handler: Handler to invoke when @name is known to not exist or %NULL.
14313 * @user_data: User data to pass to handlers.
14314 * @user_data_free_func: Function for freeing @user_data or %NULL.
14316 * Like g_bus_watch_name() but takes a #GDBusConnection instead of a
14318 * g_bus_unwatch_name() to stop watching the name.
14320 * Returns: An identifier (never 0) that an be used with
14326 * g_tls_client_connection_get_server_identity:
14327 * @conn: the #GTlsClientConnection
14329 * Gets @conn's expected server identity
14330 * expected server identity, or %NULL if the expected identity is not
14333 * Returns: a #GSocketConnectable describing the
14339 * g_action_group_get_action_enabled:
14340 * @action_group: a #GActionGroup
14341 * @action_name: the name of the action to query
14343 * Checks if the named action within @action_group is currently enabled.
14344 * An action must be enabled in order to be activated or in order to
14345 * have its state changed from outside callers.
14347 * Returns: whether or not the action is currently enabled
14353 * g_app_info_should_show:
14354 * @appinfo: a #GAppInfo.
14356 * Checks if the application info should be shown in menus that
14357 * list available applications.
14359 * Returns: %TRUE if the @appinfo should be shown, %FALSE otherwise.
14364 * g_proxy_get_default_for_protocol:
14365 * @protocol: the proxy protocol name (e.g. http, socks, etc)
14367 * Lookup "gio-proxy" extension point for a proxy implementation that supports
14368 * specified protocol.
14369 * is not supported.
14371 * Returns: (transfer full): return a #GProxy or NULL if protocol
14377 * g_dbus_connection_send_message_with_reply_finish:
14378 * @connection: a #GDBusConnection
14379 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
14380 * @error: Return location for error or %NULL.
14382 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
14383 * Note that @error is only set if a local in-process error
14384 * occured. That is to say that the returned #GDBusMessage object may
14385 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
14386 * g_dbus_message_to_gerror() to transcode this to a #GError.
14387 * See <xref linkend="gdbus-server"/> and <xref
14388 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
14389 * low-level API to send and receive UNIX file descriptors.
14391 * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set.
14397 * SECTION:gunixinputstrea:
14398 * @short_description: Streaming input operations for UNIX file descriptors
14399 * @include: gio/gunixinputstream.h
14400 * @see_also: #GInputStream
14402 * #GUnixInputStream implements #GInputStream for reading from a
14403 * UNIX file descriptor, including asynchronous operations. The file
14404 * descriptor must be selectable, so it doesn't work with opened files.
14405 * Note that <filename><gio/gunixinputstream.h></filename> belongs
14406 * to the UNIX-specific GIO interfaces, thus you have to use the
14407 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
14414 * Zlib decompression
14419 * g_dbus_server_get_guid:
14420 * @server: A #GDBusServer.
14422 * Gets the GUID for @server.
14424 * Returns: A D-Bus GUID. Do not free this string, it is owned by @server.
14430 * g_file_get_basename:
14431 * @file: input #GFile.
14433 * Gets the base name (the last component of the path) for a given #GFile.
14434 * If called for the top level of a system (such as the filesystem root
14435 * or a uri like sftp://host/) it will return a single directory separator
14436 * (and on Windows, possibly a drive letter).
14437 * The base name is a byte string (*not* UTF-8). It has no defined encoding
14438 * or rules other than it may not contain zero bytes. If you want to use
14439 * filenames in a user interface you should use the display name that you
14440 * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
14441 * attribute with g_file_query_info().
14442 * This call does no blocking i/o.
14443 * if given #GFile is invalid. The returned string should be
14444 * freed with g_free() when no longer needed.
14446 * Returns: string containing the #GFile's base name, or %NULL
14451 * g_volume_get_drive:
14452 * @volume: a #GVolume.
14454 * Gets the drive for the @volume.
14455 * The returned object should be unreffed with g_object_unref()
14456 * when no longer needed.
14458 * Returns: (transfer full): a #GDrive or %NULL if @volume is not associated with a drive.
14463 * GUnixMountMonitor::mountpoints-changed:
14464 * @monitor: the object on which the signal is emitted
14466 * Emitted when the unix mount points have changed.
14471 * GFileAttributeInfo:
14472 * @name: the name of the attribute.
14473 * @type: the #GFileAttributeType type of the attribute.
14474 * @flags: a set of #GFileAttributeInfoFlags.
14476 * Information about a specific attribute.
14482 * @G_OPTION_FLAG_HIDDEN: The option doesn't appear in <option>--help</option> output.
14483 * @G_OPTION_FLAG_IN_MAIN: The option appears in the main section of the <option>--help</option> output, even if it is defined in a group.
14484 * @G_OPTION_FLAG_REVERSE: For options of the %G_OPTION_ARG_NONE kind, this flag indicates that the sense of the option is reversed.
14485 * @G_OPTION_FLAG_NO_ARG: 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
14486 * @G_OPTION_FLAG_FILENAME: 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
14487 * @G_OPTION_FLAG_OPTIONAL_ARG: 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
14488 * @G_OPTION_FLAG_NOALIAS: This flag turns off the automatic conflict resolution which prefixes long option names with <literal>groupname-</literal> if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. It is not safe to use this option, unless all option groups are under your direct control. Since 2.8.
14490 * Flags which modify individual options.
14495 * GDBusProxy:g-interface-name:
14497 * The D-Bus interface name the proxy is for.
14504 * g_icon_to_string:
14507 * Generates a textual representation of @icon that can be used for
14508 * serialization such as when passing @icon to a different process or
14509 * saving it to persistent storage. Use g_icon_new_for_string() to
14510 * get @icon back from the returned string.
14511 * The encoding of the returned string is proprietary to #GIcon except
14512 * in the following two cases
14515 * If @icon is a #GFileIcon, the returned string is a native path
14516 * (such as <literal>/path/to/my icon.png</literal>) without escaping
14517 * if the #GFile for @icon is a native file. If the file is not
14518 * native, the returned string is the result of g_file_get_uri()
14519 * (such as <literal>sftp://path/to/my%%20icon.png</literal>).
14520 * </para></listitem>
14522 * If @icon is a #GThemedIcon with exactly one name, the encoding is
14523 * simply the name (such as <literal>network-server</literal>).
14524 * </para></listitem>
14526 * be serialized. Use g_free() to free.
14528 * Virtual: to_tokens
14529 * Returns: An allocated NUL-terminated UTF8 string or %NULL if @icon can't
14535 * g_dbus_connection_unregister_subtree:
14536 * @connection: A #GDBusConnection.
14537 * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
14539 * Unregisters a subtree.
14541 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
14547 * GPollableOutputStream:
14549 * An interface for a #GOutputStream that can be polled for readability.
14556 * g_socket_listener_accept_socket_finish:
14557 * @listener: a #GSocketListener
14558 * @result: a #GAsyncResult.
14559 * @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source
14560 * @error: a #GError location to store the error occuring, or %NULL to ignore.
14562 * Finishes an async accept operation. See g_socket_listener_accept_socket_async()
14564 * Returns: (transfer full): a #GSocket on success, %NULL on error.
14570 * G_FILE_ATTRIBUTE_SELINUX_CONTEXT:
14572 * A key in the "selinux" namespace for getting the file's SELinux
14573 * context. Corresponding #GFileAttributeType is
14574 * %G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only
14575 * available if GLib has been built with SELinux support.
14580 * g_io_extension_point_get_required_type:
14581 * @extension_point: a #GIOExtensionPoint
14583 * Gets the required type for @extension_point.
14584 * or #G_TYPE_INVALID if the extension point has no required type
14586 * Returns: the #GType that all implementations must have,
14591 * GDBusProxy:g-default-timeout:
14593 * The timeout to use if -1 (specifying default timeout) is passed
14594 * as @timeout_msec in the g_dbus_proxy_call() and
14595 * g_dbus_proxy_call_sync() functions.
14596 * This allows applications to set a proxy-wide timeout for all
14597 * remote method invocations on the proxy. If this property is -1,
14598 * the default timeout (typically 25 seconds) is used. If set to
14599 * %G_MAXINT, then no timeout is used.
14607 * @G_CONNECT_AFTER: whether the handler should be called before or after the default handler of the signal.
14608 * @G_CONNECT_SWAPPED: whether the instance and data should be swapped when calling the handler.
14610 * The connection flags are used to specify the behaviour of a signal's
14616 * g_file_info_set_attribute_uint64:
14617 * @info: a #GFileInfo.
14618 * @attribute: a file attribute key.
14619 * @attr_value: an unsigned 64-bit integer.
14621 * Sets the @attribute to contain the given @attr_value,
14627 * G_VARIANT_TYPE_BYTE:
14629 * The type of an integer value that can range from 0 to 255.
14634 * g_socket_get_timeout:
14635 * @socket: a #GSocket.
14637 * Gets the timeout setting of the socket. For details on this, see
14638 * g_socket_set_timeout().
14640 * Returns: the timeout in seconds
14646 * g_dbus_connection_set_exit_on_close:
14647 * @connection: A #GDBusConnection.
14648 * @exit_on_close: Whether the process should be terminated when @connection is closed by the remote peer.
14650 * Sets whether the process should be terminated when @connection is
14651 * closed by the remote peer. See #GDBusConnection:exit-on-close for
14659 * GFileDescriptorBasedIface:
14660 * @g_iface: The parent interface.
14667 * G_IS_PARAM_SPEC_UCHAR:
14668 * @pspec: a valid #GParamSpec instance
14670 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR.
14672 * Returns: %TRUE on success.
14677 * SECTION:gsimpleasyncresul:
14678 * @short_description: Simple asynchronous results implementation
14679 * @include: gio/gio.h
14680 * @see_also: #GAsyncResult
14682 * Implements #GAsyncResult for simple cases. Most of the time, this
14683 * will be all an application needs, and will be used transparently.
14684 * Because of this, #GSimpleAsyncResult is used throughout GIO for
14685 * handling asynchronous functions.
14686 * GSimpleAsyncResult handles #GAsyncReadyCallback<!-- -->s, error
14687 * reporting, operation cancellation and the final state of an operation,
14688 * completely transparent to the application. Results can be returned
14689 * as a pointer e.g. for functions that return data that is collected
14690 * asynchronously, a boolean value for checking the success or failure
14691 * of an operation, or a #gssize for operations which return the number
14692 * of bytes modified by the operation; all of the simple return cases
14694 * Most of the time, an application will not need to know of the details
14695 * of this API; it is handled transparently, and any necessary operations
14696 * are handled by #GAsyncResult's interface. However, if implementing a
14697 * new GIO module, for writing language bindings, or for complex
14698 * applications that need better control of how asynchronous operations
14699 * are completed, it is important to understand this functionality.
14700 * GSimpleAsyncResults are tagged with the calling function to ensure
14701 * that asynchronous functions and their finishing functions are used
14702 * together correctly.
14703 * To create a new #GSimpleAsyncResult, call g_simple_async_result_new().
14704 * If the result needs to be created for a #GError, use
14705 * g_simple_async_result_new_from_error() or
14706 * g_simple_async_result_new_take_error(). If a #GError is not available
14707 * (e.g. the asynchronous operation's doesn't take a #GError argument),
14708 * but the result still needs to be created for an error condition, use
14709 * g_simple_async_result_new_error() (or g_simple_async_result_set_error_va()
14710 * if your application or binding requires passing a variable argument list
14711 * directly), and the error can then be propagated through the use of
14712 * g_simple_async_result_propagate_error().
14713 * An asynchronous operation can be made to ignore a cancellation event by
14714 * calling g_simple_async_result_set_handle_cancellation() with a
14715 * #GSimpleAsyncResult for the operation and %FALSE. This is useful for
14716 * operations that are dangerous to cancel, such as close (which would
14717 * cause a leak if cancelled before being run).
14718 * GSimpleAsyncResult can integrate into GLib's event loop, #GMainLoop,
14719 * or it can use #GThread<!-- -->s if available.
14720 * g_simple_async_result_complete() will finish an I/O task directly
14721 * from the point where it is called. g_simple_async_result_complete_in_idle()
14722 * will finish it from an idle handler in the <link
14723 * linkend="g-main-context-push-thread-default">thread-default main
14724 * context</link>. g_simple_async_result_run_in_thread() will run the
14725 * job in a separate thread and then deliver the result to the
14726 * thread-default main context.
14727 * To set the results of an asynchronous function,
14728 * g_simple_async_result_set_op_res_gpointer(),
14729 * g_simple_async_result_set_op_res_gboolean(), and
14730 * g_simple_async_result_set_op_res_gssize()
14731 * are provided, setting the operation's result to a gpointer, gboolean, or
14732 * gssize, respectively.
14733 * Likewise, to get the result of an asynchronous function,
14734 * g_simple_async_result_get_op_res_gpointer(),
14735 * g_simple_async_result_get_op_res_gboolean(), and
14736 * g_simple_async_result_get_op_res_gssize() are
14737 * provided, getting the operation's result as a gpointer, gboolean, and
14738 * gssize, respectively.
14739 * For the details of the requirements implementations must respect, see
14740 * #GAsyncResult. A typical implementation of an asynchronous operation
14741 * using GSimpleAsyncResult looks something like this:
14744 * baked_cb (Cake *cake,
14745 * gpointer user_data)
14747 * /* In this example, this callback is not given a reference to the cake, so
14748 * * the GSimpleAsyncResult has to take a reference to it.
14750 * GSimpleAsyncResult *result = user_data;
14751 * if (cake == NULL)
14752 * g_simple_async_result_set_error (result,
14754 * BAKER_ERROR_NO_FLOUR,
14755 * "Go to the supermarket");
14757 * g_simple_async_result_set_op_res_gpointer (result,
14758 * g_object_ref (cake),
14760 * /* In this example, we assume that baked_cb is called as a callback from
14761 * * the mainloop, so it's safe to complete the operation synchronously here.
14762 * * If, however, _baker_prepare_cake () might call its callback without
14763 * * first returning to the mainloop — inadvisable, but some APIs do so —
14764 * * we would need to use g_simple_async_result_complete_in_idle().
14766 * g_simple_async_result_complete (result);
14767 * g_object_unref (result);
14770 * baker_bake_cake_async (Baker *self,
14772 * GAsyncReadyCallback callback,
14773 * gpointer user_data)
14775 * GSimpleAsyncResult *simple;
14779 * g_simple_async_report_error_in_idle (G_OBJECT (self),
14783 * BAKER_ERROR_TOO_SMALL,
14784 * "%ucm radius cakes are silly",
14788 * simple = g_simple_async_result_new (G_OBJECT (self),
14791 * baker_bake_cake_async);
14792 * cake = _baker_get_cached_cake (self, radius);
14793 * if (cake != NULL)
14795 * g_simple_async_result_set_op_res_gpointer (simple,
14796 * g_object_ref (cake),
14798 * g_simple_async_result_complete_in_idle (simple);
14799 * g_object_unref (simple);
14800 * /* Drop the reference returned by _baker_get_cached_cake(); the
14801 * * GSimpleAsyncResult has taken its own reference.
14803 * g_object_unref (cake);
14806 * _baker_prepare_cake (self, radius, baked_cb, simple);
14809 * baker_bake_cake_finish (Baker *self,
14810 * GAsyncResult *result,
14813 * GSimpleAsyncResult *simple;
14815 * g_return_val_if_fail (g_simple_async_result_is_valid (result,
14817 * baker_bake_cake_async),
14819 * simple = (GSimpleAsyncResult *) result;
14820 * if (g_simple_async_result_propagate_error (simple, error))
14822 * cake = CAKE (g_simple_async_result_get_op_res_gpointer (simple));
14823 * return g_object_ref (cake);
14830 * g_async_initable_init_finish:
14831 * @initable: a #GAsyncInitable.
14832 * @res: a #GAsyncResult.
14833 * @error: a #GError location to store the error occuring, or %NULL to ignore.
14835 * Finishes asynchronous initialization and returns the result.
14836 * See g_async_initable_init_async().
14837 * will return %FALSE and set @error appropriately if present.
14839 * Returns: %TRUE if successful. If an error has occurred, this function
14845 * g_input_stream_skip_async:
14846 * @stream: A #GInputStream.
14847 * @count: the number of bytes that will be skipped from the stream
14848 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
14849 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
14850 * @callback: (scope async): callback to call when the request is satisfied
14851 * @user_data: (closure): the data to pass to callback function
14853 * Request an asynchronous skip of @count bytes from the stream.
14854 * When the operation is finished @callback will be called.
14855 * You can then call g_input_stream_skip_finish() to get the result
14856 * of the operation.
14857 * During an async request no other sync and async calls are allowed,
14858 * and will result in %G_IO_ERROR_PENDING errors.
14859 * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
14860 * On success, the number of bytes skipped will be passed to the callback.
14861 * It is not an error if this is not the same as the requested size, as it
14862 * can happen e.g. near the end of a file, but generally we try to skip
14863 * as many bytes as requested. Zero is returned on end of file
14864 * (or if @count is zero), but never otherwise.
14865 * Any outstanding i/o request with higher priority (lower numerical value)
14866 * will be executed before an outstanding request with lower priority.
14867 * Default priority is %G_PRIORITY_DEFAULT.
14868 * The asynchronous methods have a default fallback that uses threads to
14869 * implement asynchronicity, so they are optional for inheriting classes.
14870 * However, if you override one, you must override all.
14875 * g_mount_guess_content_type_finish:
14876 * @mount: a #GMount
14877 * @result: a #GAsyncResult
14878 * @error: a #GError location to store the error occuring, or %NULL to ignore
14880 * Finishes guessing content types of @mount. If any errors occured
14881 * during the operation, @error will be set to contain the errors and
14882 * %FALSE will be returned. In particular, you may get an
14883 * %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
14885 * Caller should free this array with g_strfreev() when done with it.
14887 * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error.
14893 * GActionGroupInterface:
14894 * @has_action: the virtual function pointer for g_action_group_has_action()
14895 * @list_actions: the virtual function pointer for g_action_group_list_actions()
14896 * @get_parameter_type: the virtual function pointer for g_action_group_get_parameter_type()
14897 * @get_state_type: the virtual function pointer for g_action_group_get_state_type()
14898 * @get_state_hint: the virtual function pointer for g_action_group_get_state_hint()
14899 * @get_enabled: the virtual function pointer for g_action_group_get_enabled()
14900 * @get_state: the virtual function pointer for g_action_group_get_state()
14901 * @set_state: the virtual function pointer for g_action_group_set_state()
14902 * @activate: the virtual function pointer for g_action_group_activate()
14903 * @action_added: the class closure for the action-added signal
14904 * @action_removed: the class closure for the action-removed signal
14905 * @action_enabled_changed: the class closure for the action-enabled-changed signal
14906 * @action_state_changed: the class closure for the action-enabled-changed signal
14908 * The virtual function table for #GActionGroup.
14915 * g_cancellable_push_current:
14916 * @cancellable: a #GCancellable object
14918 * Pushes @cancellable onto the cancellable stack. The current
14919 * cancellable can then be recieved using g_cancellable_get_current().
14920 * This is useful when implementing cancellable operations in
14921 * code that does not allow you to pass down the cancellable object.
14922 * This is typically called automatically by e.g. #GFile operations,
14923 * so you rarely have to call this yourself.
14928 * g_file_query_exists:
14929 * @file: input #GFile.
14930 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
14932 * Utility function to check if a particular file exists. This is
14933 * implemented using g_file_query_info() and as such does blocking I/O.
14934 * Note that in many cases it is racy to first check for file existence
14935 * and then execute something based on the outcome of that, because the
14936 * file might have been created or removed in between the operations. The
14937 * general approach to handling that is to not check, but just do the
14938 * operation and handle the errors as they come.
14939 * As an example of race-free checking, take the case of reading a file, and
14940 * can both result in two processes creating the file (with perhaps a partially
14941 * written file as the result). The correct approach is to always try to create
14942 * the file with g_file_create() which will either atomically create the file
14943 * or fail with a G_IO_ERROR_EXISTS error.
14944 * However, in many cases an existence check is useful in a user
14945 * interface, for instance to make a menu item sensitive/insensitive, so that
14946 * you don't have to fool users that something is possible and then just show
14947 * and error dialog. If you do this, you should make sure to also handle the
14948 * errors that can happen due to races when you execute the operation.
14950 * If it doesn't exist, creating it. there are two racy versions: read it, and
14951 * On error create it; and: check if it exists, if not create it. These
14952 * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
14957 * g_inet_address_get_is_any:
14958 * @address: a #GInetAddress
14960 * Tests whether @address is the "any" address for its family.
14962 * Returns: %TRUE if @address is the "any" address for its family.
14968 * g_unix_socket_address_get_path:
14969 * @address: a #GInetSocketAddress
14971 * Gets @address's path, or for abstract sockets the "name".
14972 * Guaranteed to be zero-terminated, but an abstract socket
14973 * may contain embedded zeros, and thus you should use
14974 * g_unix_socket_address_get_path_len() to get the true length
14977 * Returns: the path for @address
14983 * SECTION:gdbusserve:
14984 * @short_description: Helper for accepting connections
14985 * @include: gio/gio.h
14987 * #GDBusServer is a helper for listening to and accepting D-Bus
14989 * <example id="gdbus-peer-to-peer"><title>D-Bus peer-to-peer example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-peer.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
14996 * The fundamental type corresponding to #gulong.
15001 * SECTION:gdbusmessag:
15002 * @short_description: D-Bus Message
15003 * @include: gio/gio.h
15005 * A type for representing D-Bus messages that can be sent or received
15006 * on a #GDBusConnection.
15012 * @parent_instance: private #GParamSpec portion
15013 * @enum_class: the #GEnumClass for the enum
15014 * @default_value: default value for the property specified
15016 * A #GParamSpec derived structure that contains the meta data for enum
15022 * G_PARAM_USER_SHIFT:
15024 * Minimum shift count to be used for user defined flags, to be stored in
15025 * #GParamSpec.flags. The maximum allowed is 30 + G_PARAM_USER_SHIFT.
15032 * A C representable type name for #G_TYPE_STRV.
15037 * G_TYPE_FROM_INTERFACE:
15038 * @g_iface: Location of a valid #GTypeInterface structure.
15040 * Get the type identifier from a given @interface structure.
15041 * This macro should only be used in type implementations.
15043 * Returns: the #GType
15048 * g_inet_address_get_is_mc_link_local:
15049 * @address: a #GInetAddress
15051 * Tests whether @address is a link-local multicast address.
15053 * Returns: %TRUE if @address is a link-local multicast address.
15061 * The #GDBusMessage structure contains only private data and should
15062 * only be accessed using the provided API.
15070 * @closure: the #GClosure to which the marshaller belongs
15071 * @return_value: a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value.
15072 * @n_param_values: the length of the @param_values array
15073 * @param_values: an array of #GValue<!-- -->s holding the arguments on which to invoke the callback of @closure
15074 * @invocation_hint: the invocation hint given as the last argument to g_closure_invoke()
15075 * @marshal_data: additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal()
15077 * The type used for marshaller functions.
15082 * g_file_enumerator_close_async:
15083 * @enumerator: a #GFileEnumerator.
15084 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
15085 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
15086 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
15087 * @user_data: (closure): the data to pass to callback function
15089 * Asynchronously closes the file enumerator.
15090 * If @cancellable is not %NULL, then the operation can be cancelled by
15091 * triggering the cancellable object from another thread. If the operation
15092 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned in
15093 * g_file_enumerator_close_finish().
15098 * G_IS_PARAM_SPEC_OVERRIDE:
15099 * @pspec: a #GParamSpec
15101 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OVERRIDE.
15104 * Returns: %TRUE on success.
15109 * SECTION:gactiongrou:
15110 * @title: GActionGroup
15111 * @short_description: A group of actions
15113 * #GActionGroup represents a group of actions.
15114 * Each action in the group has a unique name (which is a string). All
15115 * method calls, except g_action_group_list_actions() take the name of
15116 * an action as an argument.
15117 * The #GActionGroup API is meant to be the 'public' API to the action
15118 * group. The calls here are exactly the interaction that 'external
15119 * the action group implementation) are found on subclasses. This is
15120 * why you will find -- for example -- g_action_group_get_enabled() but
15121 * not an equivalent <function>set()</function> call.
15122 * Signals are emitted on the action group in response to state changes
15123 * on individual actions.
15125 * Forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have
15126 * With actions. 'internal' apis (ie: ones meant only to be accessed by
15131 * SECTION:gpollableoutputstrea:
15132 * @short_description: Interface for pollable output streams
15133 * @include: gio/gio.h
15134 * @see_also: #GOutputStream, #GFileDescriptorBased, #GPollableInputStream
15136 * #GPollableOutputStream is implemented by #GOutputStream<!-- -->s that
15137 * can be polled for readiness to write. This can be used when
15138 * interfacing with a non-GIO API that expects
15139 * UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.
15146 * GUnixOutputStream:close-fd:
15148 * Whether to close the file descriptor when the stream is closed.
15156 * @appinfo: a #GAppInfo.
15158 * Creates a duplicate of a #GAppInfo.
15160 * Returns: (transfer full): a duplicate of @appinfo.
15165 * g_srv_target_copy:
15166 * @target: a #GSrvTarget
15170 * Returns: a copy of @target
15176 * G_OBJECT_CLASS_TYPE:
15177 * @class: a valid #GObjectClass
15179 * Get the type id of a class structure.
15181 * Returns: Type id of @class.
15188 * Use this for high priority event sources.
15189 * It is not used within GLib or GTK+.
15194 * g_app_launch_context_get_display:
15195 * @context: a #GAppLaunchContext
15196 * @info: a #GAppInfo
15197 * @files: (element-type GFile): a #GList of #GFile objects
15199 * Gets the display string for the @context. This is used to ensure new
15200 * applications are started on the same display as the launching
15201 * application, by setting the <envar>DISPLAY</envar> environment variable.
15203 * Returns: a display string for the display.
15208 * g_desktop_app_info_get_is_hidden:
15209 * @info: a #GDesktopAppInfo.
15211 * A desktop file is hidden if the Hidden key in it is
15214 * Returns: %TRUE if hidden, %FALSE otherwise.
15219 * g_pollable_output_stream_is_writable:
15220 * @stream: a #GPollableOutputStream.
15222 * Checks if @stream can be written.
15223 * Note that some stream types may not be able to implement this 100%
15224 * reliably, and it is possible that a call to g_output_stream_write()
15225 * after this returns %TRUE would still block. To guarantee
15226 * non-blocking behavior, you should always use
15227 * g_pollable_output_stream_write_nonblocking(), which will return a
15228 * %G_IO_ERROR_WOULD_BLOCK error rather than blocking.
15229 * has occurred on @stream, this will result in
15230 * g_pollable_output_stream_is_writable() returning %TRUE, and the
15231 * next attempt to write will return the error.
15233 * Returns: %TRUE if @stream is writable, %FALSE if not. If an error
15239 * g_node_append_data:
15240 * @parent: the #GNode to place the new #GNode under
15241 * @data: the data for the new #GNode
15243 * Inserts a new #GNode as the last child of the given parent.
15245 * Returns: the new #GNode
15250 * g_socket_send_message:
15251 * @socket: a #GSocket
15252 * @address: a #GSocketAddress, or %NULL
15253 * @vectors: (array length=num_vectors): an array of #GOutputVector structs
15254 * @num_vectors: the number of elements in @vectors, or -1
15255 * @messages: (array length=num_messages) (allow-none): a pointer to an array of #GSocketControlMessages, or %NULL.
15256 * @num_messages: number of elements in @messages, or -1.
15257 * @flags: an int containing #GSocketMsgFlags flags
15258 * @cancellable: (allow-none): a %GCancellable or %NULL
15259 * @error: #GError for error reporting, or %NULL to ignore.
15261 * Send data to @address on @socket. This is the most complicated and
15262 * fully-featured version of this call. For easier use, see
15263 * g_socket_send() and g_socket_send_to().
15264 * If @address is %NULL then the message is sent to the default receiver
15265 * (set by g_socket_connect()).
15266 * then @vectors is assumed to be terminated by a #GOutputVector with a
15267 * %NULL buffer pointer.) The #GOutputVector structs describe the buffers
15268 * that the sent data will be gathered from. Using multiple
15269 * #GOutputVector<!-- -->s is more memory-efficient than manually copying
15270 * data from multiple sources into a single buffer, and more
15271 * network-efficient than making multiple calls to g_socket_send().
15272 * #GSocketControlMessage instances. These correspond to the control
15273 * messages to be sent on the socket.
15274 * If @num_messages is -1 then @messages is treated as a %NULL-terminated
15276 * for this are available in the #GSocketMsgFlags enum, but the
15277 * values there are the same as the system values, and the flags
15278 * are passed in as-is, so you can pass in system-specific flags too.
15279 * If the socket is in blocking mode the call will block until there is
15280 * space for the data in the socket queue. If there is no space available
15281 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
15282 * will be returned. To be notified when space is available, wait for the
15283 * %G_IO_OUT condition. Note though that you may still receive
15284 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
15285 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
15286 * very common due to the way the underlying APIs work.)
15287 * On error -1 is returned and @error is set accordingly.
15290 * Returns: Number of bytes written (which may be less than @size), or -1
15296 * GDBusInterfaceInfo:
15297 * @ref_count: The reference count or -1 if statically allocated.
15298 * @name: The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties".
15299 * @methods: A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
15300 * @signals: A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
15301 * @properties: A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
15302 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
15304 * Information about a D-Bus interface.
15311 * g_permission_release:
15312 * @permission: a #GPermission instance
15313 * @cancellable: a #GCancellable, or %NULL
15314 * @error: a pointer to a %NULL #GError, or %NULL
15315 * @returns: %TRUE if the permission was successfully released
15317 * Attempts to release the permission represented by @permission.
15318 * The precise method by which this happens depends on the permission
15319 * and the underlying authentication mechanism. In most cases the
15320 * permission will be dropped immediately without further action.
15321 * You should check with g_permission_get_can_release() before calling
15323 * If the permission is released then %TRUE is returned. Otherwise,
15324 * %FALSE is returned and @error is set appropriately.
15325 * This call is blocking, likely for a very long time (in the case that
15326 * user interaction is required). See g_permission_release_async() for
15327 * the non-blocking version.
15334 * G_VARIANT_TYPE_UINT16:
15336 * The type of an integer value that can range from 0 to 65535.
15337 * There were about this many people living in Toronto in the 1870s.
15342 * GSettings::change-event:
15343 * @settings: the object on which the signal was emitted
15344 * @keys: an array of #GQuark<!-- -->s for the changed keys, or %NULL
15345 * @n_keys: the length of the @keys array, or 0
15346 * @returns: %TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.
15348 * The "change-event" signal is emitted once per change event that
15349 * affects this settings object. You should connect to this signal
15350 * only if you are interested in viewing groups of changes before they
15351 * are split out into multiple emissions of the "changed" signal.
15352 * For most use cases it is more appropriate to use the "changed" signal.
15353 * In the event that the change event applies to one or more specified
15354 * keys, @keys will be an array of #GQuark of length @n_keys. In the
15355 * event that the change event applies to the #GSettings object as a
15356 * be %NULL and @n_keys will be 0.
15357 * The default handler for this signal invokes the "changed" signal
15358 * for each affected key. If any other connected handler returns
15359 * %TRUE then this default functionality will be supressed.
15361 * Whole (ie: potentially every key has been changed) then @keys will
15366 * GInetAddress:is-mc-org-local:
15368 * Whether this is an organization-local multicast address.
15369 * See g_inet_address_get_is_mc_org_local().
15376 * g_file_start_mountable_finish:
15377 * @file: input #GFile.
15378 * @result: a #GAsyncResult.
15379 * @error: a #GError, or %NULL
15381 * Finishes a start operation. See g_file_start_mountable() for details.
15382 * Finish an asynchronous start operation that was started
15383 * with g_file_start_mountable().
15386 * Returns: %TRUE if the operation finished successfully. %FALSE
15392 * g_input_stream_read_async:
15393 * @stream: A #GInputStream.
15394 * @buffer: a buffer to read data into (which should be at least count bytes long).
15395 * @count: the number of bytes that will be read from the stream
15396 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
15397 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
15398 * @callback: (scope async): callback to call when the request is satisfied
15399 * @user_data: (closure): the data to pass to callback function
15401 * Request an asynchronous read of @count bytes from the stream into the buffer
15402 * starting at @buffer. When the operation is finished @callback will be called.
15403 * You can then call g_input_stream_read_finish() to get the result of the
15405 * During an async request no other sync and async calls are allowed on @stream, and will
15406 * result in %G_IO_ERROR_PENDING errors.
15407 * A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
15408 * On success, the number of bytes read into the buffer will be passed to the
15409 * callback. It is not an error if this is not the same as the requested size, as it
15410 * can happen e.g. near the end of a file, but generally we try to read
15411 * as many bytes as requested. Zero is returned on end of file
15412 * (or if @count is zero), but never otherwise.
15413 * Any outstanding i/o request with higher priority (lower numerical value) will
15414 * be executed before an outstanding request with lower priority. Default
15415 * priority is %G_PRIORITY_DEFAULT.
15416 * The asyncronous methods have a default fallback that uses threads to implement
15417 * asynchronicity, so they are optional for inheriting classes. However, if you
15418 * override one you must override all.
15423 * g_data_input_stream_new:
15424 * @base_stream: a #GInputStream.
15426 * Creates a new data input stream for the @base_stream.
15428 * Returns: a new #GDataInputStream.
15434 * @file: input #GFile.
15436 * Gets the URI for the @file.
15437 * This call does no blocking i/o.
15438 * The returned string should be freed with g_free() when no longer needed.
15440 * Returns: a string containing the #GFile's URI.
15445 * g_mount_get_volume:
15446 * @mount: a #GMount.
15448 * Gets the volume for the @mount.
15449 * The returned object should be unreffed with
15450 * g_object_unref() when no longer needed.
15452 * Returns: (transfer full): a #GVolume or %NULL if @mount is not associated with a volume.
15457 * g_buffered_input_stream_get_available:
15458 * @stream: #GBufferedInputStream
15460 * Gets the size of the available data within the stream.
15462 * Returns: size of the available stream.
15467 * GDBusSendMessageFlags:
15468 * @G_DBUS_SEND_MESSAGE_FLAGS_NONE: No flags set.
15469 * @G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL: Do not automatically assign a serial number from the #GDBusConnection object when sending a message.
15471 * Flags used when sending #GDBusMessage<!-- -->s on a #GDBusConnection.
15478 * g_settings_reset:
15479 * @settings: a #GSettings object
15480 * @key: the name of a key
15482 * Resets @key to its default value.
15483 * This call resets the key, as much as possible, to its default value.
15484 * That might the value specified in the schema or the one set by the
15490 * G_FILE_ATTRIBUTE_STANDARD_DESCRIPTION:
15492 * A key in the "standard" namespace for getting the description of the file.
15493 * The description is a utf8 string that describes the file, generally containing
15494 * the filename, but can also contain furter information. Example descriptions
15495 * could be "filename (on hostname)" for a remote file or "filename (in trash)"
15496 * for a file in the trash. This is useful for instance as the window title
15497 * when displaying a directory or for a bookmarks menu.
15498 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
15503 * SECTION:gdbusaddres:
15504 * @title: D-Bus Addresses
15505 * @short_description: D-Bus connection endpoints
15506 * @include: gio/gio.h
15508 * Routines for working with D-Bus addresses. A D-Bus address is a string
15509 * like "unix:tmpdir=/tmp/my-app-name". The exact format of addresses
15510 * is explained in detail in the <link linkend="http://dbus.freedesktop.org/doc/dbus-specification.html#addresses">D-Bus specification</link>.
15515 * g_volume_eject_finish:
15516 * @volume: pointer to a #GVolume.
15517 * @result: a #GAsyncResult.
15518 * @error: a #GError location to store an error, or %NULL to ignore
15520 * Finishes ejecting a volume. If any errors occured during the operation,
15522 * Returns: %TRUE, %FALSE if operation failed.
15523 * Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead.
15529 * @file: input #GFile.
15531 * Duplicates a #GFile handle. This operation does not duplicate
15532 * the actual file or directory represented by the #GFile; see
15533 * g_file_copy() if attempting to copy a file.
15534 * This call does no blocking i/o.
15536 * Returns: (transfer full): a new #GFile that is a duplicate of the given #GFile.
15541 * g_unix_mount_points_changed_since:
15542 * @time: guint64 to contain a timestamp.
15544 * Checks if the unix mount points have changed since a given unix time.
15546 * Returns: %TRUE if the mount points have changed since @time.
15551 * SECTION:gdbusauthobserve:
15552 * @short_description: Object used for authenticating connections
15553 * @include: gio/gio.h
15555 * The #GDBusAuthObserver type provides a mechanism for participating
15556 * in how a #GDBusServer (or a #GDBusConnection) authenticates remote
15557 * peers. Simply instantiate a #GDBusAuthObserver and connect to the
15558 * signals you are interested in. Note that new signals may be added
15560 * For example, if you only want to allow D-Bus connections from
15561 * processes owned by the same uid as the server, you would use a
15562 * signal handler like the following:
15563 * <example id="auth-observer"><title>Controlling Authentication</title><programlisting>
15565 * on_authorize_authenticated_peer (GDBusAuthObserver *observer,
15566 * GIOStream *stream,
15567 * GCredentials *credentials,
15568 * gpointer user_data)
15570 * gboolean authorized;
15571 * authorized = FALSE;
15572 * if (credentials != NULL)
15574 * GCredentials *own_credentials;
15575 * own_credentials = g_credentials_new ();
15576 * if (g_credentials_is_same_user (credentials, own_credentials, NULL))
15577 * authorized = TRUE;
15578 * g_object_unref (own_credentials);
15580 * return authorized;
15582 * </programlisting></example>
15587 * G_TYPE_PARAM_VARIANT:
15589 * The #GType of #GParamSpecVariant.
15596 * g_settings_set_string:
15597 * @settings: a #GSettings object
15598 * @key: the name of the key to set
15599 * @value: the value to set it to
15600 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
15602 * Sets @key in @settings to @value.
15603 * A convenience variant of g_settings_set() for strings.
15604 * It is a programmer error to give a @key that isn't specified as
15605 * having a string type in the schema for @settings.
15612 * GBusNameAppearedCallback:
15613 * @connection: The #GDBusConnection the name is being watched on.
15614 * @name: The name being watched.
15615 * @name_owner: Unique name of the owner of the name being watched.
15616 * @user_data: User data passed to g_bus_watch_name().
15618 * Invoked when the name being watched is known to have to have a owner.
15625 * g_mount_unmount_finish:
15626 * @mount: a #GMount.
15627 * @result: a #GAsyncResult.
15628 * @error: a #GError location to store the error occuring, or %NULL to ignore.
15630 * Finishes unmounting a mount. If any errors occurred during the operation,
15632 * Returns: %TRUE if the mount was successfully unmounted. %FALSE otherwise.
15633 * Deprecated: 2.22: Use g_mount_unmount_with_operation_finish() instead.
15638 * g_buffered_output_stream_get_buffer_size:
15639 * @stream: a #GBufferedOutputStream.
15641 * Gets the size of the buffer in the @stream.
15643 * Returns: the current size of the buffer.
15648 * g_action_group_list_actions:
15649 * @action_group: a #GActionGroup
15651 * Lists the actions contained within @action_group.
15652 * The caller is responsible for freeing the list with g_strfreev() when
15653 * it is no longer required.
15654 * actions in the groupb
15656 * Returns: (transfer full): a %NULL-terminated array of the names of the
15663 * @G_USER_DIRECTORY_DESKTOP: the user's Desktop directory
15664 * @G_USER_DIRECTORY_DOCUMENTS: the user's Documents directory
15665 * @G_USER_DIRECTORY_DOWNLOAD: the user's Downloads directory
15666 * @G_USER_DIRECTORY_MUSIC: the user's Music directory
15667 * @G_USER_DIRECTORY_PICTURES: the user's Pictures directory
15668 * @G_USER_DIRECTORY_PUBLIC_SHARE: the user's shared directory
15669 * @G_USER_DIRECTORY_TEMPLATES: the user's Templates directory
15670 * @G_USER_DIRECTORY_VIDEOS: the user's Movies directory
15671 * @G_USER_N_DIRECTORIES: the number of enum values
15673 * These are logical ids for special directories which are defined
15674 * depending on the platform used. You should use g_get_user_special_dir()
15675 * to retrieve the full path associated to the logical id.
15676 * The #GUserDirectory enumeration can be extended at later date. Not
15677 * every platform has a directory for every logical id in this
15685 * g_dbus_method_invocation_return_error_literal:
15686 * @invocation: A #GDBusMethodInvocation.
15687 * @domain: A #GQuark for the #GError error domain.
15688 * @code: The error code.
15689 * @message: The error message.
15691 * Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
15692 * This method will free @invocation, you cannot use it afterwards.
15699 * g_dbus_message_get_serial:
15700 * @message: A #GDBusMessage.
15702 * Gets the serial for @message.
15704 * Returns: A #guint32.
15710 * GTlsRehandshakeMode:
15711 * @G_TLS_REHANDSHAKE_NEVER: Never allow rehandshaking
15712 * @G_TLS_REHANDSHAKE_SAFELY: Allow safe rehandshaking only
15713 * @G_TLS_REHANDSHAKE_UNSAFELY: Allow unsafe rehandshaking
15715 * When to allow rehandshaking. See
15716 * g_tls_connection_set_rehandshake_mode().
15723 * g_file_attribute_matcher_ref:
15724 * @matcher: a #GFileAttributeMatcher.
15726 * References a file attribute matcher.
15728 * Returns: a #GFileAttributeMatcher.
15733 * GFilenameCompleter:
15735 * Completes filenames based on files that exist within the file system.
15741 * @ref_count: The reference count or -1 if statically allocated.
15742 * @name: The name of the D-Bus signal, e.g. "NameOwnerChanged".
15743 * @args: A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no arguments.
15744 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
15746 * Information about a signal on a D-Bus interface.
15753 * G_SIGNAL_MATCH_MASK:
15755 * A mask for all #GSignalMatchType bits.
15762 * Creates a new file info structure.
15764 * Returns: a #GFileInfo.
15769 * g_unix_output_stream_new:
15770 * @fd: a UNIX file descriptor
15771 * @close_fd: %TRUE to close the file descriptor when done
15773 * Creates a new #GUnixOutputStream for the given @fd.
15774 * If @close_fd, is %TRUE, the file descriptor will be closed when
15775 * the output stream is destroyed.
15777 * Returns: a new #GOutputStream
15782 * g_input_stream_close:
15783 * @stream: A #GInputStream.
15784 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
15785 * @error: location to store the error occuring, or %NULL to ignore
15787 * Closes the stream, releasing resources related to it.
15788 * Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED.
15789 * Closing a stream multiple times will not return an error.
15790 * Streams will be automatically closed when the last reference
15791 * is dropped, but you might want to call this function to make sure
15792 * resources are released as early as possible.
15793 * Some streams might keep the backing store of the stream (e.g. a file descriptor)
15794 * open after the stream is closed. See the documentation for the individual
15795 * stream for details.
15796 * On failure the first error that happened will be reported, but the close
15797 * operation will finish as much as possible. A stream that failed to
15798 * close will still return %G_IO_ERROR_CLOSED for all operations. Still, it
15799 * is important to check and report the error to the user.
15800 * If @cancellable is not NULL, then the operation can be cancelled by
15801 * triggering the cancellable object from another thread. If the operation
15802 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
15803 * Cancelling a close will still leave the stream closed, but some streams
15804 * can use a faster close that doesn't block to e.g. check errors.
15806 * Returns: %TRUE on success, %FALSE on failure
15811 * g_dbus_annotation_info_lookup:
15812 * @annotations: A %NULL-terminated array of annotations or %NULL.
15813 * @name: The name of the annotation to look up.
15815 * Looks up the value of an annotation.
15816 * This cost of this function is O(n) in number of annotations.
15818 * Returns: The value or %NULL if not found. Do not free, it is owned by @annotations.
15824 * g_file_set_display_name_async:
15825 * @file: input #GFile.
15826 * @display_name: a string.
15827 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
15828 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
15829 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
15830 * @user_data: (closure): the data to pass to callback function
15832 * Asynchronously sets the display name for a given #GFile.
15833 * For more details, see g_file_set_display_name() which is
15834 * the synchronous version of this call.
15835 * When the operation is finished, @callback will be called. You can then call
15836 * g_file_set_display_name_finish() to get the result of the operation.
15841 * g_socket_listener_accept_finish:
15842 * @listener: a #GSocketListener
15843 * @result: a #GAsyncResult.
15844 * @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source
15845 * @error: a #GError location to store the error occuring, or %NULL to ignore.
15847 * Finishes an async accept operation. See g_socket_listener_accept_async()
15849 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
15855 * GSimpleAction:parameter-type:
15857 * The type of the parameter that must be given when activating the
15865 * g_proxy_supports_hostname:
15866 * @proxy: a #GProxy
15868 * Some proxy protocols expect to be passed a hostname, which they
15869 * will resolve to an IP address themselves. Others, like SOCKS4, do
15870 * not allow this. This function will return %FALSE if @proxy is
15871 * implementing such a protocol. When %FALSE is returned, the caller
15872 * should resolve the destination hostname first, and then pass a
15873 * #GProxyAddress containing the stringified IP address to
15874 * g_proxy_connect() or g_proxy_connect_async().
15876 * Returns: %TRUE if hostname resolution is supported.
15882 * g_file_info_get_attribute_uint64:
15883 * @info: a #GFileInfo.
15884 * @attribute: a file attribute key.
15886 * Gets a unsigned 64-bit integer contained within the attribute. If the
15887 * attribute does not contain an unsigned 64-bit integer, or is invalid,
15888 * 0 will be returned.
15890 * Returns: a unsigned 64-bit integer from the attribute.
15895 * g_dbus_message_get_sender:
15896 * @message: A #GDBusMessage.
15898 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
15900 * Returns: The value.
15906 * g_tls_connection_handshake:
15907 * @conn: a #GTlsConnection
15908 * @cancellable: a #GCancellable, or %NULL
15909 * @error: a #GError, or %NULL
15911 * Attempts a TLS handshake on @conn.
15912 * On the client side, it is never necessary to call this method;
15913 * although the connection needs to perform a handshake after
15914 * connecting (or after sending a "STARTTLS"-type command) and may
15915 * need to rehandshake later if the server requests it,
15916 * #GTlsConnection will handle this for you automatically when you try
15917 * to send or receive data on the connection. However, you can call
15918 * g_tls_connection_handshake() manually if you want to know for sure
15919 * whether the initial handshake succeeded or failed (as opposed to
15920 * just immediately trying to write to @conn's output stream, in which
15921 * case if it fails, it may not be possible to tell if it failed
15922 * before or after completing the handshake).
15923 * Likewise, on the server side, although a handshake is necessary at
15924 * the beginning of the communication, you do not need to call this
15925 * function explicitly unless you want clearer error reporting.
15926 * However, you may call g_tls_connection_handshake() later on to
15927 * renegotiate parameters (encryption methods, etc) with the client.
15928 * #GTlsConnection::accept_certificate may be emitted during the
15931 * Returns: success or failure
15938 * @type: a #GType ID.
15940 * Checks whether @type "is a" %G_TYPE_ENUM.
15942 * Returns: %TRUE if @type "is a" %G_TYPE_ENUM.
15947 * g_mount_operation_set_username:
15948 * @op: a #GMountOperation.
15949 * @username: input username.
15951 * Sets the user name within @op to @username.
15956 * GSourceCallbackFuncs:
15957 * @ref: Called when a reference is added to the callback object
15958 * @unref: Called when a reference to the callback object is dropped
15959 * @get: Called to extract the callback function and data from the callback object.
15961 * The <structname>GSourceCallbackFuncs</structname> struct contains
15962 * functions for managing callback objects.
15967 * GDBusProxy:g-name:
15969 * The well-known or unique name that the proxy is for.
15977 * @mount: A #GMount.
15979 * Increments the shadow count on @mount. Usually used by
15980 * #GVolumeMonitor implementations when creating a shadow mount for
15981 * will need to emit the #GMount::changed signal on @mount manually.
15990 * Stores information about a file system object referenced by a #GFile.
15996 * @object: Object which is subject to casting.
15998 * Casts a #GObject or derived pointer into a (GObject*) pointer.
15999 * Depending on the current debugging level, this function may invoke
16000 * certain runtime checks to identify invalid casts.
16005 * GTlsConnection:peer-certificate:
16007 * The connection's peer's certificate, after the TLS handshake has
16008 * completed and the certificate has been accepted. Note in
16009 * particular that this is not yet set during the emission of
16010 * #GTlsConnection::accept-certificate.
16011 * (You can watch for a #GObject::notify signal on this property to
16012 * detect when a handshake has occurred.)
16019 * g_file_query_filesystem_info_async:
16020 * @file: input #GFile.
16021 * @attributes: an attribute query string.
16022 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
16023 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
16024 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
16025 * @user_data: (closure): the data to pass to callback function
16027 * Asynchronously gets the requested information about the filesystem
16028 * that the specified @file is on. The result is a #GFileInfo object
16029 * that contains key-value attributes (such as type or size for the
16031 * For more details, see g_file_query_filesystem_info() which is the
16032 * synchronous version of this call.
16033 * When the operation is finished, @callback will be called. You can
16034 * then call g_file_query_info_finish() to get the result of the
16040 * g_file_attribute_info_list_add:
16041 * @list: a #GFileAttributeInfoList.
16042 * @name: the name of the attribute to add.
16043 * @type: the #GFileAttributeType for the attribute.
16044 * @flags: #GFileAttributeInfoFlags for the attribute.
16046 * Adds a new attribute with @name to the @list, setting
16047 * its @type and @flags.
16055 * Returns %TRUE if a #GNode is the root of a tree.
16056 * (i.e. it has no parent or siblings)
16058 * Returns: %TRUE if the #GNode is the root of a tree
16063 * GUnixInputStream:close-fd:
16065 * Whether to close the file descriptor when the stream is closed.
16072 * g_content_type_from_mime_type:
16073 * @mime_type: a mime type string
16075 * Tries to find a content type based on the mime type name.
16076 * or %NULL. Free with g_free()
16078 * Returns: (allow-none): Newly allocated string with content type
16084 * g_srv_target_get_port:
16085 * @target: a #GSrvTarget
16087 * Gets @target's port
16089 * Returns: @target's port
16096 * @mount: a #GMount.
16097 * @flags: flags affecting the unmount if required for eject
16098 * @cancellable: optional #GCancellable object, %NULL to ignore.
16099 * @callback: a #GAsyncReadyCallback, or %NULL.
16100 * @user_data: user data passed to @callback.
16102 * Ejects a mount. This is an asynchronous operation, and is
16103 * finished by calling g_mount_eject_finish() with the @mount
16104 * and #GAsyncResult data returned in the @callback.
16106 * Deprecated: 2.22: Use g_mount_eject_with_operation() instead.
16111 * G_VALUE_HOLDS_CHAR:
16112 * @value: a valid #GValue structure
16114 * Checks whether the given #GValue can hold values of type %G_TYPE_CHAR.
16116 * Returns: %TRUE on success.
16121 * G_TYPE_IS_FUNDAMENTAL:
16122 * @type: A #GType value.
16124 * Checks if @type is a fundamental type.
16126 * Returns: %TRUE on success.
16131 * g_dbus_error_get_remote_error:
16132 * @error: A #GError.
16134 * Gets the D-Bus error name used for @error, if any.
16135 * This function is guaranteed to return a D-Bus error name for all
16136 * #GError<!-- -->s returned from functions handling remote method
16137 * calls (e.g. g_dbus_connection_call_finish()) unless
16138 * g_dbus_error_strip_remote_error() has been used on @error.
16140 * Returns: An allocated string or %NULL if the D-Bus error name could not be found. Free with g_free().
16146 * SECTION:gsettingsbacken:
16147 * @title: GSettingsBackend
16148 * @short_description: Interface for settings backend implementations
16149 * @include: gio/gsettingsbackend.h
16150 * @see_also: #GSettings, #GIOExtensionPoint
16152 * The #GSettingsBackend interface defines a generic interface for
16153 * non-strictly-typed data that is stored in a hierarchy. To implement
16154 * an alternative storage backend for #GSettings, you need to implement
16155 * the #GSettingsBackend interface and then make it implement the
16156 * extension point #G_SETTINGS_BACKEND_EXTENSION_POINT_NAME.
16157 * The interface defines methods for reading and writing values, a
16158 * method for determining if writing of certain values will fail
16159 * (lockdown) and a change notification mechanism.
16160 * The semantics of the interface are very precisely defined and
16161 * implementations must carefully adhere to the expectations of
16162 * callers that are documented on each of the interface methods.
16163 * Some of the GSettingsBackend functions accept or return a #GTree.
16164 * These trees always have strings as keys and #GVariant as values.
16165 * g_settings_backend_create_tree() is a convenience function to create
16168 * The #GSettingsBackend API is exported to allow third-party
16169 * implementations, but does not carry the same stability guarantees
16170 * as the public GIO API. For this reason, you have to define the
16171 * C preprocessor symbol #G_SETTINGS_ENABLE_BACKEND before including
16172 * <filename>gio/gsettingsbackend.h</filename>
16178 * g_dbus_interface_info_lookup_method:
16179 * @info: A #GDBusInterfaceInfo.
16180 * @name: A D-Bus method name (typically in CamelCase)
16182 * Looks up information about a method.
16183 * This cost of this function is O(n) in number of methods.
16185 * Returns: A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info.
16191 * GDBusConnection:closed:
16193 * A boolean specifying whether the connection has been closed.
16201 * @g_iface: The parent interface.
16202 * @connect: Connect to proxy server and wrap (if required) the #connection to handle payload.
16203 * @connect_async: Same has connect() but asynchronous.
16204 * @connect_finish: Returns the result of connect_async()
16206 * Provides an interface for handling proxy connection and payload.
16213 * g_zlib_compressor_new:
16214 * @format: The format to use for the compressed data
16215 * @level: compression level (0-9), -1 for default
16217 * Creates a new #GZlibCompressor.
16219 * Returns: a new #GZlibCompressor
16225 * g_cancellable_disconnect:
16226 * @cancellable: A #GCancellable or %NULL.
16227 * @handler_id: Handler id of the handler to be disconnected, or %0.
16229 * Disconnects a handler from a cancellable instance similar to
16230 * g_signal_handler_disconnect(). Additionally, in the event that a
16231 * signal handler is currently running, this call will block until the
16232 * handler has finished. Calling this function from a
16233 * #GCancellable::cancelled signal handler will therefore result in a
16235 * This avoids a race condition where a thread cancels at the
16236 * same time as the cancellable operation is finished and the
16237 * signal handler is removed. See #GCancellable::cancelled for
16238 * details on how to use this.
16239 * If @cancellable is %NULL or @handler_id is %0 this function does
16247 * GTlsClientConnection:server-identity:
16249 * A #GSocketConnectable describing the identity of the server that
16250 * is expected on the other end of the connection.
16251 * If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in
16252 * #GTlsClientConnection:validation-flags, this object will be used
16253 * to determine the expected identify of the remote end of the
16254 * connection; if #GTlsClientConnection:server-identity is not set,
16255 * or does not match the identity presented by the server, then the
16256 * %G_TLS_CERTIFICATE_BAD_IDENTITY validation will fail.
16257 * In addition to its use in verifying the server certificate,
16258 * this is also used to give a hint to the server about what
16259 * certificate we expect, which is useful for servers that serve
16267 * g_input_stream_skip_finish:
16268 * @stream: a #GInputStream.
16269 * @result: a #GAsyncResult.
16270 * @error: a #GError location to store the error occuring, or %NULL to ignore.
16272 * Finishes a stream skip operation.
16274 * Returns: the size of the bytes skipped, or %-1 on error.
16281 * A per matched file iterator.
16286 * g_resolver_set_default:
16287 * @resolver: the new default #GResolver
16289 * Sets @resolver to be the application's default resolver (reffing
16290 * Future calls to g_resolver_get_default() will return this resolver.
16291 * This can be used if an application wants to perform any sort of DNS
16292 * caching or "pinning"; it can implement its own #GResolver that
16293 * calls the original default resolver for DNS operations, and
16294 * implements its own cache policies on top of that, and then set
16295 * itself as the default resolver for all later code to use.
16302 * g_dbus_annotation_info_unref:
16303 * @info: A #GDBusAnnotationInfo.
16305 * If @info is statically allocated, does nothing. Otherwise decreases
16306 * the reference count of @info. When its reference count drops to 0,
16307 * the memory used is freed.
16314 * g_file_info_set_sort_order:
16315 * @info: a #GFileInfo.
16316 * @sort_order: a sort order integer.
16318 * Sets the sort order attribute in the file info structure. See
16319 * %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.
16324 * SECTION:goutputstrea:
16325 * @short_description: Base class for implementing streaming output
16326 * @include: gio/gio.h
16328 * GOutputStream has functions to write to a stream (g_output_stream_write()),
16329 * to close a stream (g_output_stream_close()) and to flush pending writes
16330 * (g_output_stream_flush()).
16331 * To copy the content of an input stream to an output stream without
16332 * manually handling the reads and writes, use g_output_stream_splice().
16333 * All of these functions have async variants too.
16338 * SECTION:gmemoryinputstrea:
16339 * @short_description: Streaming input operations on memory chunks
16340 * @include: gio/gio.h
16341 * @see_also: #GMemoryOutputStream
16343 * #GMemoryInputStream is a class for using arbitrary
16344 * memory chunks as input for GIO streaming input operations.
16349 * G_VALUE_HOLDS_UINT:
16350 * @value: a valid #GValue structure
16352 * Checks whether the given #GValue can hold values of type %G_TYPE_UINT.
16354 * Returns: %TRUE on success.
16359 * g_action_get_name:
16360 * @action: a #GAction
16362 * Queries the name of @action.
16364 * Returns: the name of the action
16371 * @short_description: Virtual File System
16372 * @include: gio/gio.h
16374 * Entry point for using GIO functionality.
16379 * g_file_output_stream_query_info_async:
16380 * @stream: a #GFileOutputStream.
16381 * @attributes: a file attribute query string.
16382 * @io_priority: the <link linkend="gio-GIOScheduler">I/O priority</link> of the request.
16383 * @cancellable: optional #GCancellable object, %NULL to ignore.
16384 * @callback: callback to call when the request is satisfied
16385 * @user_data: the data to pass to callback function
16387 * Asynchronously queries the @stream for a #GFileInfo. When completed,
16388 * finish the operation with g_file_output_stream_query_info_finish().
16389 * For the synchronous version of this function, see
16390 * g_file_output_stream_query_info().
16395 * g_dbus_connection_remove_filter:
16396 * @connection: a #GDBusConnection
16397 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
16399 * Removes a filter.
16406 * G_PARAM_SPEC_GTYPE:
16407 * @pspec: a #GParamSpec
16409 * Casts a #GParamSpec into a #GParamSpecGType.
16418 * The #GType for a boxed type holding a #GError.
16425 * g_resolver_lookup_by_name:
16426 * @resolver: a #GResolver
16427 * @hostname: the hostname to look up
16428 * @cancellable: (allow-none): a #GCancellable, or %NULL
16429 * @error: return location for a #GError, or %NULL
16431 * Synchronously resolves @hostname to determine its associated IP
16432 * address(es). @hostname may be an ASCII-only or UTF-8 hostname, or
16433 * the textual form of an IP address (in which case this just becomes
16434 * a wrapper around g_inet_address_new_from_string()).
16435 * On success, g_resolver_lookup_by_name() will return a #GList of
16436 * #GInetAddress, sorted in order of preference. (That is, you should
16437 * attempt to connect to the first address first, then the second if
16438 * the first fails, etc.)
16439 * If the DNS resolution fails, @error (if non-%NULL) will be set to a
16440 * value from #GResolverError.
16441 * If @cancellable is non-%NULL, it can be used to cancel the
16442 * operation, in which case @error (if non-%NULL) will be set to
16443 * %G_IO_ERROR_CANCELLED.
16444 * If you are planning to connect to a socket on the resolved IP
16445 * address, it may be easier to create a #GNetworkAddress and use its
16446 * #GSocketConnectable interface.
16447 * of #GInetAddress, or %NULL on error. You
16448 * must unref each of the addresses and free the list when you are
16449 * done with it. (You can use g_resolver_free_addresses() to do this.)
16451 * Returns: (element-type GInetAddress) (transfer full): a #GList
16457 * g_socket_listener_accept_async:
16458 * @listener: a #GSocketListener
16459 * @cancellable: (allow-none): a #GCancellable, or %NULL
16460 * @callback: (scope async): a #GAsyncReadyCallback
16461 * @user_data: (closure): user data for the callback
16463 * This is the asynchronous version of g_socket_listener_accept().
16464 * When the operation is finished @callback will be
16465 * called. You can then call g_socket_listener_accept_socket()
16466 * to get the result of the operation.
16473 * g_mount_unshadow:
16474 * @mount: A #GMount.
16476 * Decrements the shadow count on @mount. Usually used by
16477 * #GVolumeMonitor implementations when destroying a shadow mount for
16478 * will need to emit the #GMount::changed signal on @mount manually.
16485 * g_file_info_get_is_backup:
16486 * @info: a #GFileInfo.
16488 * Checks if a file is a backup file.
16490 * Returns: %TRUE if file is a backup file, %FALSE otherwise.
16495 * G_VARIANT_TYPE_BASIC:
16497 * An indefinite type that is a supertype of every basic (ie:
16498 * non-container) type.
16503 * g_dbus_connection_call:
16504 * @connection: A #GDBusConnection.
16505 * @bus_name: A unique or well-known bus name or %NULL if @connection is not a message bus connection.
16506 * @object_path: Path of remote object.
16507 * @interface_name: D-Bus interface to invoke method on.
16508 * @method_name: The name of the method to invoke.
16509 * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
16510 * @reply_type: The expected type of the reply, or %NULL.
16511 * @flags: Flags from the #GDBusCallFlags enumeration.
16512 * @timeout_msec: The timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout.
16513 * @cancellable: A #GCancellable or %NULL.
16514 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.
16515 * @user_data: The data to pass to @callback.
16517 * Asynchronously invokes the @method_name method on the
16518 * If @connection is closed then the operation will fail with
16519 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
16520 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
16521 * not compatible with the D-Bus protocol, the operation fails with
16522 * %G_IO_ERROR_INVALID_ARGUMENT.
16523 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
16524 * error will be raised if it does not match. Said another way, if you give a @reply_type
16525 * then any non-%NULL return value will be of this type.
16526 * If the @parameters #GVariant is floating, it is consumed. This allows
16527 * convenient 'inline' use of g_variant_new(), e.g.:
16529 * g_dbus_connection_call (connection,
16530 * "org.freedesktop.StringThings",
16531 * "/org/freedesktop/StringThings",
16532 * "org.freedesktop.StringThings",
16534 * g_variant_new ("(ss)",
16538 * G_DBUS_CALL_FLAGS_NONE,
16541 * (GAsyncReadyCallback) two_strings_done,
16544 * This is an asynchronous method. When the operation is finished, @callback will be invoked
16545 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
16546 * of the thread you are calling this method from. You can then call
16547 * g_dbus_connection_call_finish() to get the result of the operation.
16548 * See g_dbus_connection_call_sync() for the synchronous version of this
16556 * g_unix_fd_message_get_fd_list:
16557 * @message: a #GUnixFDMessage
16559 * Gets the #GUnixFDList contained in @message. This function does not
16560 * return a reference to the caller, but the returned list is valid for
16561 * the lifetime of @message.
16563 * Returns: (transfer none): the #GUnixFDList from @message
16571 * A type which is used to hold a process identification.
16572 * On UNIX, processes are identified by a process id (an integer),
16573 * while Windows uses process handles (which are pointers).
16578 * g_filter_input_stream_get_base_stream:
16579 * @stream: a #GFilterInputStream.
16581 * Gets the base stream for the filter stream.
16583 * Returns: (transfer none): a #GInputStream.
16588 * g_data_input_stream_get_byte_order:
16589 * @stream: a given #GDataInputStream.
16591 * Gets the byte order for the data input stream.
16593 * Returns: the @stream's current #GDataStreamByteOrder.
16598 * G_IS_OBJECT_CLASS:
16599 * @class: a #GObjectClass
16601 * Checks whether @class "is a" valid #GObjectClass structure of type
16602 * %G_TYPE_OBJECT or derived.
16609 * Interface that can be used to resolve proxy address.
16614 * G_TLS_BACKEND_EXTENSION_POINT_NAME:
16616 * Extension point for TLS functionality via #GTlsBackend.
16617 * See <link linkend="extending-gio">Extending GIO</link>.
16622 * SECTION:gdbuserro:
16623 * @title: GDBusError
16624 * @short_description: Mapping D-Bus errors to and from GError
16625 * @include: gio/gio.h
16627 * All facilities that return errors from remote methods (such as
16628 * g_dbus_connection_call_sync()) use #GError to represent both D-Bus
16629 * errors (e.g. errors returned from the other peer) and locally
16630 * in-process generated errors.
16631 * To check if a returned #GError is an error from a remote peer, use
16632 * g_dbus_error_is_remote_error(). To get the actual D-Bus error name,
16633 * use g_dbus_error_get_remote_error(). Before presenting an error,
16634 * always use g_dbus_error_strip_remote_error().
16635 * In addition, facilities used to return errors to a remote peer also
16636 * use #GError. See g_dbus_method_invocation_return_error() for
16637 * discussion about how the D-Bus error name is set.
16638 * Applications can associate a #GError error domain with a set of D-Bus errors in order to
16639 * automatically map from D-Bus errors to #GError and back. This
16640 * is typically done in the function returning the #GQuark for the
16642 * <example id="error-registration"><title>Error Registration</title><programlisting>
16643 * /<!-- -->* foo-bar-error.h: *<!-- -->/
16644 * #define FOO_BAR_ERROR (foo_bar_error_quark ())
16645 * GQuark foo_bar_error_quark (void);
16648 * FOO_BAR_ERROR_FAILED,
16649 * FOO_BAR_ERROR_ANOTHER_ERROR,
16650 * FOO_BAR_ERROR_SOME_THIRD_ERROR,
16652 * /<!-- -->* foo-bar-error.c: *<!-- -->/
16653 * static const GDBusErrorEntry foo_bar_error_entries[] =
16655 * {FOO_BAR_ERROR_FAILED, "org.project.Foo.Bar.Error.Failed"},
16656 * {FOO_BAR_ERROR_ANOTHER_ERROR, "org.project.Foo.Bar.Error.AnotherError"},
16657 * {FOO_BAR_ERROR_SOME_THIRD_ERROR, "org.project.Foo.Bar.Error.SomeThirdError"},
16660 * foo_bar_error_quark (void)
16662 * static volatile gsize quark_volatile = 0;
16663 * g_dbus_error_register_error_domain ("foo-bar-error-quark",
16665 * foo_bar_error_entries,
16666 * G_N_ELEMENTS (foo_bar_error_entries));
16667 * G_STATIC_ASSERT (G_N_ELEMENTS (foo_bar_error_entries) - 1 == FOO_BAR_ERROR_SOME_THIRD_ERROR);
16668 * return (GQuark) quark_volatile;
16670 * </programlisting></example>
16671 * With this setup, a D-Bus peer can transparently pass e.g. %FOO_BAR_ERROR_ANOTHER_ERROR and
16672 * other peers will see the D-Bus error name <literal>org.project.Foo.Bar.Error.AnotherError</literal>.
16673 * If the other peer is using GDBus, the peer will see also %FOO_BAR_ERROR_ANOTHER_ERROR instead
16674 * of %G_IO_ERROR_DBUS_ERROR. Note that GDBus clients can still recover
16675 * <literal>org.project.Foo.Bar.Error.AnotherError</literal> using g_dbus_error_get_remote_error().
16676 * Note that errors in the %G_DBUS_ERROR error domain is intended only
16677 * for returning errors from a remote message bus process. Errors
16678 * generated locally in-process by e.g. #GDBusConnection is from the
16679 * %G_IO_ERROR domain.
16684 * g_seekable_truncate:
16685 * @seekable: a #GSeekable.
16686 * @offset: a #goffset.
16687 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
16688 * @error: a #GError location to store the error occuring, or %NULL to ignore.
16690 * Truncates a stream with a given #offset.
16691 * If @cancellable is not %NULL, then the operation can be cancelled by
16692 * triggering the cancellable object from another thread. If the operation
16693 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
16694 * operation was partially finished when the operation was cancelled the
16695 * partial result will be returned, without an error.
16696 * has occurred, this function will return %FALSE and set @error
16697 * appropriately if present.
16699 * Virtual: truncate_fn
16700 * Returns: %TRUE if successful. If an error
16705 * g_dbus_message_new_method_error:
16706 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to.
16707 * @error_name: A valid D-Bus error name.
16708 * @error_message_format: The D-Bus error message in a printf() format.
16709 * @...: Arguments for @error_message_format.
16711 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
16713 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
16719 * g_volume_eject_with_operation:
16720 * @volume: a #GVolume.
16721 * @flags: flags affecting the unmount if required for eject
16722 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
16723 * @cancellable: optional #GCancellable object, %NULL to ignore.
16724 * @callback: a #GAsyncReadyCallback, or %NULL.
16725 * @user_data: user data passed to @callback.
16727 * Ejects a volume. This is an asynchronous operation, and is
16728 * finished by calling g_volume_eject_with_operation_finish() with the @volume
16729 * and #GAsyncResult data returned in the @callback.
16737 * @settings: a #GSettings object
16738 * @key: the key to bind
16739 * @object: (type GObject.Object): a #GObject
16740 * @property: the name of the property to bind
16741 * @flags: flags for the binding
16743 * Create a binding between the @key in the @settings object
16744 * and the property @property of @object.
16745 * The binding uses the default GIO mapping functions to map
16746 * between the settings and property values. These functions
16747 * handle booleans, numeric types and string types in a
16748 * straightforward way. Use g_settings_bind_with_mapping() if
16749 * you need a custom mapping, or map between types that are not
16750 * supported by the default mapping functions.
16751 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
16752 * function also establishes a binding between the writability of
16753 * a boolean property by that name). See g_settings_bind_writable()
16754 * for more details about writable bindings.
16755 * Note that the lifecycle of the binding is tied to the object,
16756 * and that you can have only one binding per object property.
16757 * If you bind the same property twice on the same object, the second
16758 * binding overrides the first one.
16765 * g_socket_client_connect_to_host_async:
16766 * @client: a #GTcpClient
16767 * @host_and_port: the name and optionally the port of the host to connect to
16768 * @default_port: the default port to connect to
16769 * @cancellable: (allow-none): a #GCancellable, or %NULL
16770 * @callback: (scope async): a #GAsyncReadyCallback
16771 * @user_data: (closure): user data for the callback
16773 * This is the asynchronous version of g_socket_client_connect_to_host().
16774 * When the operation is finished @callback will be
16775 * called. You can then call g_socket_client_connect_to_host_finish() to get
16776 * the result of the operation.
16783 * GInitiallyUnownedClass:
16785 * The class structure for the <structname>GInitiallyUnowned</structname> type.
16790 * g_file_info_set_content_type:
16791 * @info: a #GFileInfo.
16792 * @content_type: a content type. See #GContentType.
16794 * Sets the content type attribute for a given #GFileInfo.
16795 * See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE.
16800 * g_dbus_proxy_get_flags:
16801 * @proxy: A #GDBusProxy.
16803 * Gets the flags that @proxy was constructed with.
16805 * Returns: Flags from the #GDBusProxyFlags enumeration.
16811 * GAppInfoCreateFlags:
16812 * @G_APP_INFO_CREATE_NONE: No flags.
16813 * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens in a terminal window.
16814 * @G_APP_INFO_CREATE_SUPPORTS_URIS: Application supports URI arguments.
16815 * @G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION: Application supports startup notification. Since 2.26
16817 * Flags used when creating a #GAppInfo.
16822 * g_unix_fd_list_new_from_array:
16823 * @fds: (array length=n_fds): the initial list of file descriptors
16824 * @n_fds: the length of #fds, or -1
16826 * Creates a new #GUnixFDList containing the file descriptors given in
16827 * may no longer be used by the caller. The array itself is owned by
16829 * Each file descriptor in the array should be set to close-on-exec.
16830 * If @n_fds is -1 then @fds must be terminated with -1.
16832 * Returns: a new #GUnixFDList
16838 * g_loadable_icon_load_async:
16839 * @icon: a #GLoadableIcon.
16840 * @size: an integer.
16841 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
16842 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
16843 * @user_data: (closure): the data to pass to callback function
16845 * Loads an icon asynchronously. To finish this function, see
16846 * g_loadable_icon_load_finish(). For the synchronous, blocking
16847 * version of this function, see g_loadable_icon_load().
16852 * g_dbus_message_new_from_blob:
16853 * @blob: A blob represent a binary D-Bus message.
16854 * @blob_len: The length of @blob.
16855 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
16856 * @error: Return location for error or %NULL.
16858 * Creates a new #GDBusMessage from the data stored at @blob. The byte
16859 * order that the message was in can be retrieved using
16860 * g_dbus_message_get_byte_order().
16861 * g_object_unref().
16863 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
16869 * G_TYPE_CLASS_GET_PRIVATE:
16870 * @klass: the class of a type deriving from @private_type.
16871 * @g_type: the type identifying which private data to retrieve.
16872 * @c_type: The C type for the private structure.
16874 * Gets the private class structure for a particular type.
16875 * The private structure must have been registered in the
16876 * get_type() function with g_type_add_class_private().
16877 * This macro should only be used in type implementations.
16880 * Returns: a pointer to the private data structure.
16885 * g_dbus_error_set_dbus_error:
16886 * @error: A pointer to a #GError or %NULL.
16887 * @dbus_error_name: D-Bus error name.
16888 * @dbus_error_message: D-Bus error message.
16889 * @format: printf()-style format to prepend to @dbus_error_message or %NULL.
16890 * @...: Arguments for @format.
16892 * Does nothing if @error is %NULL. Otherwise sets *@error to
16893 * a new #GError created with g_dbus_error_new_for_dbus_error()
16894 * with @dbus_error_message prepend with @format (unless %NULL).
16901 * g_file_query_info_finish:
16902 * @file: input #GFile.
16903 * @res: a #GAsyncResult.
16904 * @error: a #GError.
16906 * Finishes an asynchronous file info query.
16907 * See g_file_query_info_async().
16908 * Free the returned object with g_object_unref().
16910 * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
16915 * GDBusConnection:unique-name:
16917 * The unique name as assigned by the message bus or %NULL if the
16918 * connection is not open or not a message bus connection.
16925 * g_file_attribute_info_list_lookup:
16926 * @list: a #GFileAttributeInfoList.
16927 * @name: the name of the attribute to lookup.
16929 * Gets the file attribute with the name @name from @list.
16930 * attribute isn't found.
16932 * Returns: a #GFileAttributeInfo for the @name, or %NULL if an
16937 * G_PARAM_SPEC_POINTER:
16938 * @pspec: a valid #GParamSpec instance
16940 * Casts a #GParamSpec instance into a #GParamSpecPointer.
16945 * g_file_enumerator_close_finish:
16946 * @enumerator: a #GFileEnumerator.
16947 * @result: a #GAsyncResult.
16948 * @error: a #GError location to store the error occuring, or %NULL to ignore.
16950 * Finishes closing a file enumerator, started from g_file_enumerator_close_async().
16951 * If the file enumerator was already closed when g_file_enumerator_close_async()
16952 * was called, then this function will report %G_IO_ERROR_CLOSED in @error, and
16953 * return %FALSE. If the file enumerator had pending operation when the close
16954 * operation was started, then this function will report %G_IO_ERROR_PENDING, and
16955 * return %FALSE. If @cancellable was not %NULL, then the operation may have been
16956 * cancelled by triggering the cancellable object from another thread. If the operation
16957 * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be
16960 * Returns: %TRUE if the close operation has finished successfully.
16965 * GSimpleAction:name:
16967 * The name of the action. This is mostly meaningful for identifying
16968 * the action once it has been added to a #GSimpleActionGroup.
16975 * g_app_info_set_as_default_for_type:
16976 * @appinfo: a #GAppInfo.
16977 * @content_type: the content type.
16978 * @error: a #GError.
16980 * Sets the application as the default handler for a given type.
16982 * Returns: %TRUE on success, %FALSE on error.
16987 * GSimpleAsyncThreadFunc:
16988 * @res: a #GSimpleAsyncResult.
16989 * @object: a #GObject.
16990 * @cancellable: optional #GCancellable object, %NULL to ignore.
16992 * Simple thread function that runs an asynchronous operation and
16993 * checks for cancellation.
16998 * g_filter_input_stream_get_close_base_stream:
16999 * @stream: a #GFilterInputStream.
17001 * Returns whether the base stream will be closed when @stream is
17004 * Returns: %TRUE if the base stream will be closed.
17009 * GDBusMessageType:
17010 * @G_DBUS_MESSAGE_TYPE_INVALID: Message is of invalid type.
17011 * @G_DBUS_MESSAGE_TYPE_METHOD_CALL: Method call.
17012 * @G_DBUS_MESSAGE_TYPE_METHOD_RETURN: Method reply.
17013 * @G_DBUS_MESSAGE_TYPE_ERROR: Error reply.
17014 * @G_DBUS_MESSAGE_TYPE_SIGNAL: Signal emission.
17016 * Message types used in #GDBusMessage.
17025 * The <structname>GBookmarkFile</structname> struct contains only
17026 * private data and should not be directly accessed.
17031 * G_VARIANT_TYPE_INT16:
17033 * The type of an integer value that can range from -32768 to 32767.
17038 * g_io_stream_clear_pending:
17039 * @stream: a #GIOStream
17041 * Clears the pending flag on @stream.
17048 * g_permission_release_async:
17049 * @permission: a #GPermission instance
17050 * @cancellable: a #GCancellable, or %NULL
17051 * @callback: the #GAsyncReadyCallback to call when done
17052 * @user_data: the user data to pass to @callback
17054 * Attempts to release the permission represented by @permission.
17055 * This is the first half of the asynchronous version of
17056 * g_permission_release().
17063 * g_tls_connection_get_certificate:
17064 * @conn: a #GTlsConnection
17066 * Gets @conn's certificate, as set by
17067 * g_tls_connection_set_certificate().
17069 * Returns: (transfer none): @conn's certificate, or %NULL
17075 * g_unix_mount_guess_name:
17076 * @mount_entry: a #GUnixMountEntry
17078 * Guesses the name of a Unix mount.
17079 * The result is a translated string.
17080 * be freed with g_free()
17082 * Returns: A newly allocated string that must
17087 * GDBusConnection:exit-on-close:
17089 * A boolean specifying whether the process will be terminated (by
17090 * calling <literal>raise(SIGTERM)</literal>) if the connection
17091 * is closed by the remote peer.
17098 * g_hash_table_freeze:
17099 * @hash_table: a #GHashTable
17101 * This function is deprecated and will be removed in the next major
17102 * release of GLib. It does nothing.
17107 * G_VARIANT_TYPE_OBJECT_PATH:
17109 * The type of a DBus object reference. These are strings of a
17110 * specific format used to identify objects at a given destination on
17112 * If you are not interacting with DBus, then there is no reason to make
17113 * use of this type. If you are, then the DBus specification contains a
17114 * precise description of valid object paths.
17119 * g_simple_async_result_get_source_tag: (skip)
17120 * @simple: a #GSimpleAsyncResult.
17122 * Gets the source tag for the #GSimpleAsyncResult.
17124 * Returns: a #gpointer to the source object for the #GSimpleAsyncResult.
17129 * G_FILE_ATTRIBUTE_OWNER_USER_REAL:
17131 * A key in the "owner" namespace for getting the real name of the
17132 * user that owns the file. Corresponding #GFileAttributeType is
17133 * %G_FILE_ATTRIBUTE_TYPE_STRING.
17140 * All the fields in the <structname>GObject</structname> structure are private
17141 * to the #GObject implementation and should never be accessed directly.
17147 * @short_description: An object for emblems
17148 * @include: gio/gio.h
17149 * @see_also: #GIcon, #GEmblemedIcon, #GLoadableIcon, #GThemedIcon
17151 * #GEmblem is an implementation of #GIcon that supports
17152 * having an emblem, which is an icon with additional properties.
17153 * It can than be added to a #GEmblemedIcon.
17154 * Currently, only metainformation about the emblem's origin is
17155 * supported. More may be added in the future.
17160 * g_threaded_socket_service_new:
17161 * @max_threads: the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit
17163 * Creates a new #GThreadedSocketService with no listeners. Listeners
17164 * must be added with g_socket_service_add_listeners().
17166 * Returns: a new #GSocketService.
17172 * g_pollable_source_new: (skip)
17173 * @pollable_stream: the stream associated with the new source
17175 * Utility method for #GPollableInputStream and #GPollableOutputStream
17176 * implementations. Creates a new #GSource that expects a callback of
17177 * type #GPollableSourceFunc. The new source does not actually do
17178 * anything on its own; use g_source_add_child_source() to add other
17179 * sources to it to cause it to trigger.
17181 * Returns: (transfer full): the new #GSource.
17187 * G_IMPLEMENT_INTERFACE:
17188 * @TYPE_IFACE: The #GType of the interface to add
17189 * @iface_init: The interface init function
17191 * A convenience macro to ease interface addition in the @_C_ section
17192 * of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
17193 * See G_DEFINE_TYPE_EXTENDED() for an example.
17194 * Note that this macro can only be used together with the G_DEFINE_TYPE_*
17195 * macros, since it depends on variable names from those macros.
17202 * g_file_monitor_cancel:
17203 * @monitor: a #GFileMonitor.
17205 * Cancels a file monitor.
17207 * Returns: %TRUE if monitor was cancelled.
17212 * SECTION:gfileiostrea:
17213 * @short_description: File read and write streaming operations
17214 * @include: gio/gio.h
17215 * @see_also: #GIOStream, #GFileInputStream, #GFileOutputStream, #GSeekable
17217 * GFileIOStream provides io streams that both read and write to the same
17219 * GFileIOStream implements #GSeekable, which allows the io
17220 * stream to jump to arbitrary positions in the file and to truncate
17221 * the file, provided the filesystem of the file supports these
17223 * To find the position of a file io stream, use
17224 * g_seekable_tell().
17225 * To find out if a file io stream supports seeking, use g_seekable_can_seek().
17226 * To position a file io stream, use g_seekable_seek().
17227 * To find out if a file io stream supports truncating, use
17228 * g_seekable_can_truncate(). To truncate a file io
17229 * stream, use g_seekable_truncate().
17230 * The default implementation of all the #GFileIOStream operations
17231 * and the implementation of #GSeekable just call into the same operations
17232 * on the output stream.
17239 * g_mount_get_root:
17240 * @mount: a #GMount.
17242 * Gets the root directory on @mount.
17243 * The returned object should be unreffed with
17244 * g_object_unref() when no longer needed.
17246 * Returns: (transfer full): a #GFile.
17251 * G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE:
17253 * A key in the "standard" namespace for getting the content type of the file.
17254 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
17255 * The value for this key should contain a valid content type.
17260 * SECTION:gunixmount:
17261 * @include: gio/gunixmounts.h
17262 * @short_description: UNIX mounts
17264 * Routines for managing mounted UNIX mount points and paths.
17265 * Note that <filename><gio/gunixmounts.h></filename> belongs to the
17266 * UNIX-specific GIO interfaces, thus you have to use the
17267 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
17273 * @parent_instance: private #GParamSpec portion
17275 * A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM
17282 * @fd: the file descriptor to poll (or a <type>HANDLE</type> on Win32)
17283 * @events: 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.
17284 * @revents: a bitwise combination of flags from #GIOCondition, returned from the poll() function to indicate which events occurred.
17291 * G_FILE_ATTRIBUTE_TIME_ACCESS_USEC:
17293 * A key in the "time" namespace for getting the microseconds of the time
17294 * the file was last accessed. This should be used in conjunction with
17295 * #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is
17296 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
17301 * g_mount_unmount_with_operation_finish:
17302 * @mount: a #GMount.
17303 * @result: a #GAsyncResult.
17304 * @error: a #GError location to store the error occuring, or %NULL to ignore.
17306 * Finishes unmounting a mount. If any errors occurred during the operation,
17308 * Returns: %TRUE if the mount was successfully unmounted. %FALSE otherwise.
17314 * GDBusMessageByteOrder:
17315 * @G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN: The byte order is big endian.
17316 * @G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN: The byte order is little endian.
17318 * Enumeration used to describe the byte order of a D-Bus message.
17325 * g_app_info_launch:
17326 * @appinfo: a #GAppInfo
17327 * @files: (element-type GFile): a #GList of #GFile objects
17328 * @launch_context: (allow-none): a #GAppLaunchContext or %NULL
17329 * @error: a #GError
17331 * Launches the application. Passes @files to the launched application
17332 * as arguments, using the optional @launch_context to get information
17333 * about the details of the launcher (like what screen it is on).
17334 * On error, @error will be set accordingly.
17335 * To launch the application without arguments pass a %NULL @files list.
17336 * Note that even if the launch is successful the application launched
17337 * can fail to start if it runs into problems during startup. There is
17338 * no way to detect this.
17339 * Some URIs can be changed when passed through a GFile (for instance
17340 * unsupported uris with strange formats like mailto:), so if you have
17341 * a textual uri you want to pass in as argument, consider using
17342 * g_app_info_launch_uris() instead.
17343 * On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>
17344 * environment variable with the path of the launched desktop file and
17345 * <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process
17346 * id of the launched process. This can be used to ignore
17347 * <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>, should it be inherited
17348 * by further processes. The <envar>DISPLAY</envar> and
17349 * <envar>DESKTOP_STARTUP_ID</envar> environment variables are also
17350 * set, based on information provided in @launch_context.
17352 * Returns: %TRUE on successful launch, %FALSE otherwise.
17358 * @parent_instance: private #GParamSpec portion
17359 * @minimum: minimum value for the property specified
17360 * @maximum: maximum value for the property specified
17361 * @default_value: default value for the property specified
17363 * A #GParamSpec derived structure that contains the meta data for character properties.
17368 * GVolumeMonitor::drive-disconnected:
17369 * @volume_monitor: The volume monitor emitting the signal.
17370 * @drive: a #GDrive that was disconnected.
17372 * Emitted when a drive is disconnected from the system.
17377 * GDBusSubtreeDispatchFunc:
17378 * @connection: A #GDBusConnection.
17379 * @sender: The unique bus name of the remote caller.
17380 * @object_path: The object path that was registered with g_dbus_connection_register_subtree().
17381 * @interface_name: The D-Bus interface name that the method call or property access is for.
17382 * @node: A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree.
17383 * @out_user_data: Return location for user data to pass to functions in the returned #GDBusInterfaceVTable (never %NULL).
17384 * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
17386 * The type of the @dispatch function in #GDBusSubtreeVTable.
17387 * Subtrees are flat. @node, if non-%NULL, is always exactly one
17389 * Segment of the object path (ie: it never contains a slash).
17390 * Returns: A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods.
17397 * @G_FILE_COPY_NONE: No flags set.
17398 * @G_FILE_COPY_OVERWRITE: Overwrite any existing files
17399 * @G_FILE_COPY_BACKUP: Make a backup of any existing files.
17400 * @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks.
17401 * @G_FILE_COPY_ALL_METADATA: Copy all file metadata instead of just default set used for copy (see #GFileInfo).
17402 * @G_FILE_COPY_NO_FALLBACK_FOR_MOVE: Don't use copy and delete fallback if native move not supported.
17403 * @G_FILE_COPY_TARGET_DEFAULT_PERMS: Leaves target file with default perms, instead of setting the source file perms.
17405 * Flags used when copying or moving files.
17410 * g_bus_watch_name:
17411 * @bus_type: The type of bus to watch a name on.
17412 * @name: The name (well-known or unique) to watch.
17413 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
17414 * @name_appeared_handler: Handler to invoke when @name is known to exist or %NULL.
17415 * @name_vanished_handler: Handler to invoke when @name is known to not exist or %NULL.
17416 * @user_data: User data to pass to handlers.
17417 * @user_data_free_func: Function for freeing @user_data or %NULL.
17419 * Starts watching @name on the bus specified by @bus_type and calls
17420 * known to have a owner respectively known to lose its
17421 * owner. Callbacks will be invoked in the <link
17422 * linkend="g-main-context-push-thread-default">thread-default main
17423 * loop</link> of the thread you are calling this function from.
17424 * You are guaranteed that one of the handlers will be invoked after
17425 * calling this function. When you are done watching the name, just
17426 * call g_bus_unwatch_name() with the watcher id this function
17428 * If the name vanishes or appears (for example the application owning
17429 * the name could restart), the handlers are also invoked. If the
17430 * #GDBusConnection that is used for watching the name disconnects, then
17431 * possible to access the name.
17432 * Another guarantee is that invocations of @name_appeared_handler
17433 * and @name_vanished_handler are guaranteed to alternate; that
17434 * is, if @name_appeared_handler is invoked then you are
17435 * guaranteed that the next time one of the handlers is invoked, it
17436 * will be @name_vanished_handler. The reverse is also true.
17437 * This behavior makes it very simple to write applications that wants
17438 * to take action when a certain name exists, see <xref
17439 * linkend="gdbus-watching-names"/>. Basically, the application
17440 * should create object proxies in @name_appeared_handler and destroy
17441 * them again (if any) in @name_vanished_handler.
17442 * g_bus_unwatch_name() to stop watching the name.
17444 * Returns: An identifier (never 0) that an be used with
17450 * g_desktop_app_info_new_from_filename:
17451 * @filename: the path of a desktop file, in the GLib filename encoding
17453 * Creates a new #GDesktopAppInfo.
17455 * Returns: a new #GDesktopAppInfo or %NULL on error.
17460 * g_io_extension_point_get_extension_by_name:
17461 * @extension_point: a #GIOExtensionPoint
17462 * @name: the name of the extension to get
17464 * Finds a #GIOExtension for an extension point by name.
17465 * given name, or %NULL if there is no extension with that name
17467 * Returns: (transfer none): the #GIOExtension for @extension_point that has the
17472 * G_FILE_ATTRIBUTE_UNIX_NLINK:
17474 * A key in the "unix" namespace for getting the number of hard links
17475 * for a file. See lstat() documentation. This attribute is only available
17476 * for UNIX file systems. Corresponding #GFileAttributeType is
17477 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
17482 * g_tls_connection_handshake_async:
17483 * @conn: a #GTlsConnection
17484 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
17485 * @cancellable: a #GCancellable, or %NULL
17486 * @callback: callback to call when the handshake is complete
17487 * @user_data: the data to pass to the callback function
17489 * Asynchronously performs a TLS handshake on @conn. See
17490 * g_tls_connection_handshake() for more information.
17499 * An invalid #GType used as error return value in some functions which return
17505 * g_volume_can_eject:
17506 * @volume: a #GVolume.
17508 * Checks if a volume can be ejected.
17510 * Returns: %TRUE if the @volume can be ejected. %FALSE otherwise.
17515 * G_IS_PARAM_SPEC_FLOAT:
17516 * @pspec: a valid #GParamSpec instance
17518 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT.
17520 * Returns: %TRUE on success.
17525 * g_app_info_create_from_commandline:
17526 * @commandline: the commandline to use
17527 * @application_name: (allow-none): the application name, or %NULL to use @commandline
17528 * @flags: flags that can specify details of the created #GAppInfo
17529 * @error: a #GError location to store the error occuring, %NULL to ignore.
17531 * Creates a new #GAppInfo from the given information.
17533 * Returns: (transfer full): new #GAppInfo for given command.
17538 * g_socket_client_get_protocol:
17539 * @client: a #GSocketClient
17541 * Gets the protocol name type of the socket client.
17542 * See g_socket_client_set_protocol() for details.
17544 * Returns: a #GSocketProtocol
17550 * G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO:
17552 * Allowed characters in userinfo as defined in RFC 3986. Includes "!$&'()*+,;=:".
17557 * g_dbus_message_get_body:
17558 * @message: A #GDBusMessage.
17560 * Gets the body of a message.
17562 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
17568 * g_permission_get_can_acquire:
17569 * @permission: a #GPermission instance
17570 * @returns: the value of the 'can-acquire' property
17572 * Gets the value of the 'can-acquire' property. This property is %TRUE
17573 * if it is generally possible to acquire the permission by calling
17574 * g_permission_acquire().
17581 * G_TYPE_PARAM_INT:
17583 * The #GType of #GParamSpecInt.
17588 * g_desktop_app_info_new:
17589 * @desktop_id: the desktop file id
17591 * Creates a new #GDesktopAppInfo based on a desktop file id.
17592 * A desktop file id is the basename of the desktop file, including the
17593 * .desktop extension. GIO is looking for a desktop file with this name
17594 * in the <filename>applications</filename> subdirectories of the XDG data
17595 * directories (i.e. the directories specified in the
17596 * <envar>XDG_DATA_HOME</envar> and <envar>XDG_DATA_DIRS</envar> environment
17597 * variables). GIO also supports the prefix-to-subdirectory mapping that is
17598 * described in the <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Menu Spec</ulink>
17599 * (i.e. a desktop id of kde-foo.desktop will match
17600 * <filename>/usr/share/applications/kde/foo.desktop</filename>).
17602 * Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id
17607 * g_io_scheduler_job_send_to_mainloop_async:
17608 * @job: a #GIOSchedulerJob
17609 * @func: a #GSourceFunc callback that will be called in the original thread
17610 * @user_data: data to pass to @func
17611 * @notify: a #GDestroyNotify for @user_data, or %NULL
17613 * Used from an I/O job to send a callback to be run asynchronously in
17614 * the thread that the job was started from. The callback will be run
17615 * when the main loop is available, but at that time the I/O job might
17616 * have finished. The return value from the callback is ignored.
17617 * Note that if you are passing the @user_data from g_io_scheduler_push_job()
17618 * on to this function you have to ensure that it is not freed before
17619 * g_io_scheduler_push_job() or by using refcounting for @user_data.
17624 * G_IS_INITIALLY_UNOWNED:
17625 * @object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
17627 * Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED.
17633 * @value: A #GValue structure.
17635 * Checks if @value is a valid and initialized #GValue structure.
17637 * Returns: %TRUE on success.
17642 * g_application_command_line_getenv:
17643 * @cmdline: a #GApplicationCommandLine
17644 * @name: the environment variable to get
17646 * Gets the value of a particular environment variable of the command
17647 * line invocation, as would be returned by g_getenv(). The strings may
17648 * contain non-utf8 data.
17649 * The remote application usually does not send an environment. Use
17650 * %G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag
17651 * set it is possible that the environment is still not available (due
17652 * to invocation messages from other applications).
17653 * The return value should not be modified or freed and is valid for as
17654 * long as @cmdline exists.
17656 * Returns: the value of the variable, or %NULL if unset or unsent
17662 * g_simple_async_result_set_from_error:
17663 * @simple: a #GSimpleAsyncResult.
17666 * Sets the result from a #GError.
17671 * g_file_info_set_attribute_int64:
17672 * @info: a #GFileInfo.
17673 * @attribute: attribute name to set.
17674 * @attr_value: int64 value to set attribute to.
17676 * Sets the @attribute to contain the given @attr_value,
17682 * g_data_input_stream_read_uint16:
17683 * @stream: a given #GDataInputStream.
17684 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
17685 * @error: #GError for error reporting.
17687 * Reads an unsigned 16-bit/2-byte value from @stream.
17688 * In order to get the correct byte order for this read operation,
17689 * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
17690 * an error occurred.
17692 * Returns: an unsigned 16-bit/2-byte value read from the @stream or %0 if
17697 * GDBusSignalCallback:
17698 * @connection: A #GDBusConnection.
17699 * @sender_name: The unique bus name of the sender of the signal.
17700 * @object_path: The object path that the signal was emitted on.
17701 * @interface_name: The name of the interface.
17702 * @signal_name: The name of the signal.
17703 * @parameters: A #GVariant tuple with parameters for the signal.
17704 * @user_data: User data passed when subscribing to the signal.
17706 * Signature for callback function used in g_dbus_connection_signal_subscribe().
17713 * g_socket_client_set_socket_type:
17714 * @client: a #GSocketClient.
17715 * @type: a #GSocketType
17717 * Sets the socket type of the socket client.
17718 * The sockets created by this object will be of the specified
17720 * It doesn't make sense to specify a type of %G_SOCKET_TYPE_DATAGRAM,
17721 * as GSocketClient is used for connection oriented services.
17728 * GDBusAuthMechanism:credentials:
17730 * If authenticating as a server, this property contains the
17731 * received credentials, if any.
17732 * If authenticating as a client, the property contains the
17733 * credentials that were sent, if any.
17738 * G_TYPE_PARAM_PARAM:
17740 * The #GType of #GParamSpecParam.
17745 * G_PARAM_SPEC_UCHAR:
17746 * @pspec: a valid #GParamSpec instance
17748 * Cast a #GParamSpec instance into a #GParamSpecUChar.
17754 * @data: data that was provided when the weak reference was established
17755 * @where_the_object_was: the object being finalized
17757 * A #GWeakNotify function can be added to an object as a callback that gets
17758 * triggered when the object is finalized. Since the object is already being
17759 * finalized when the #GWeakNotify is called, there's not much you could do
17760 * with the object, apart from e.g. using its adress as hash-index or the like.
17765 * g_socket_client_set_tls_validation_flags:
17766 * @client: a #GSocketClient.
17767 * @flags: the validation flags
17769 * Sets the TLS validation flags used when creating TLS connections
17770 * via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL.
17778 * @pid: the process id of the child process
17779 * @status: Status information about the child process, see waitpid(2) for more information about this field
17780 * @data: user data passed to g_child_watch_add()
17782 * The type of functions to be called when a child exists.
17787 * g_io_extension_point_set_required_type:
17788 * @extension_point: a #GIOExtensionPoint
17789 * @type: the #GType to require
17791 * Sets the required type for @extension_point to @type.
17792 * All implementations must henceforth have this type.
17797 * GSettingsBackend:
17799 * An implementation of a settings storage repository.
17804 * g_converter_reset:
17805 * @converter: a #GConverter.
17807 * Resets all internal state in the converter, making it behave
17808 * as if it was just created. If the converter has any internal
17809 * state that would produce output then that output is lost.
17816 * g_buffered_output_stream_new_sized:
17817 * @base_stream: a #GOutputStream.
17820 * Creates a new buffered output stream with a given buffer size.
17822 * Returns: a #GOutputStream with an internal buffer set to @size.
17827 * GDBusServer:active:
17829 * Whether the server is currently active.
17836 * GDBusPropertyInfo:
17837 * @ref_count: The reference count or -1 if statically allocated.
17838 * @name: The name of the D-Bus property, e.g. "SupportedFilesystems".
17839 * @signature: The D-Bus signature of the property (a single complete type).
17840 * @flags: Access control flags for the property.
17841 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
17843 * Information about a D-Bus property on a D-Bus interface.
17850 * g_file_set_attribute_byte_string:
17851 * @file: input #GFile.
17852 * @attribute: a string containing the attribute's name.
17853 * @value: a string containing the attribute's new value.
17854 * @flags: a #GFileQueryInfoFlags.
17855 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
17856 * @error: a #GError, or %NULL
17858 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
17859 * If @attribute is of a different type, this operation will fail,
17860 * returning %FALSE.
17861 * If @cancellable is not %NULL, then the operation can be cancelled by
17862 * triggering the cancellable object from another thread. If the operation
17863 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
17864 * in the @file, %FALSE otherwise.
17866 * Returns: %TRUE if the @attribute was successfully set to @value
17871 * g_tls_connection_set_rehandshake_mode:
17872 * @conn: a #GTlsConnection
17873 * @mode: the rehandshaking mode
17875 * Sets how @conn behaves with respect to rehandshaking requests.
17876 * %G_TLS_REHANDSHAKE_NEVER means that it will never agree to
17877 * rehandshake after the initial handshake is complete. (For a client,
17878 * this means it will refuse rehandshake requests from the server, and
17879 * for a server, this means it will close the connection with an error
17880 * if the client attempts to rehandshake.)
17881 * %G_TLS_REHANDSHAKE_SAFELY means that the connection will allow a
17882 * rehandshake only if the other end of the connection supports the
17883 * TLS <literal>renegotiation_info</literal> extension. This is the
17884 * default behavior, but means that rehandshaking will not work
17885 * against older implementations that do not support that extension.
17886 * %G_TLS_REHANDSHAKE_UNSAFELY means that the connection will allow
17887 * rehandshaking even without the
17888 * <literal>renegotiation_info</literal> extension. On the server side
17889 * in particular, this is not recommended, since it leaves the server
17890 * open to certain attacks. However, this mode is necessary if you
17891 * need to allow renegotiation with older client software.
17898 * G_VALUE_HOLDS_ENUM:
17899 * @value: a valid #GValue structure
17901 * Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM.
17903 * Returns: %TRUE on success.
17908 * G_PARAM_SPEC_UINT64:
17909 * @pspec: a valid #GParamSpec instance
17911 * Cast a #GParamSpec instance into a #GParamSpecUInt64.
17917 * @socket: a #GSocket.
17918 * @error: #GError for error reporting, or %NULL to ignore.
17920 * Marks the socket as a server socket, i.e. a socket that is used
17921 * to accept incoming requests using g_socket_accept().
17922 * Before calling this the socket must be bound to a local address using
17924 * To set the maximum amount of outstanding clients, use
17925 * g_socket_set_listen_backlog().
17927 * Returns: %TRUE on success, %FALSE on error.
17933 * g_simple_async_result_complete_in_idle:
17934 * @simple: a #GSimpleAsyncResult.
17936 * Completes an asynchronous function in an idle handler in the <link
17937 * linkend="g-main-context-push-thread-default">thread-default main
17938 * loop</link> of the thread that @simple was initially created in.
17939 * Calling this function takes a reference to @simple for as long as
17940 * is needed to complete the call.
17945 * G_VARIANT_TYPE_BOOLEAN:
17947 * The type of a value that can be either %TRUE or %FALSE.
17952 * g_file_info_set_attribute_byte_string:
17953 * @info: a #GFileInfo.
17954 * @attribute: a file attribute key.
17955 * @attr_value: a byte string.
17957 * Sets the @attribute to contain the given @attr_value,
17963 * g_data_output_stream_put_uint64:
17964 * @stream: a #GDataOutputStream.
17965 * @data: a #guint64.
17966 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
17967 * @error: a #GError, %NULL to ignore.
17969 * Puts an unsigned 64-bit integer into the stream.
17971 * Returns: %TRUE if @data was successfully added to the @stream.
17976 * SECTION:gdbusprox:
17977 * @short_description: Client-side proxies
17978 * @include: gio/gio.h
17980 * #GDBusProxy is a base class used for proxies to access a D-Bus
17981 * interface on a remote object. A #GDBusProxy can be constructed for
17982 * both well-known and unique names.
17983 * By default, #GDBusProxy will cache all properties (and listen to
17984 * changes) of the remote object, and proxy all signals that gets
17985 * emitted. This behaviour can be changed by passing suitable
17986 * #GDBusProxyFlags when the proxy is created. If the proxy is for a
17987 * well-known name, the property cache is flushed when the name owner
17988 * vanishes and reloaded when a name owner appears.
17989 * If a #GDBusProxy is used for a well-known name, the owner of the
17990 * name is tracked and can be read from
17991 * #GDBusProxy:g-name-owner. Connect to the #GObject::notify signal to
17992 * get notified of changes. Additionally, only signals and property
17993 * changes emitted from the current name owner are considered and
17994 * calls are always sent to the current name owner. This avoids a
17995 * number of race conditions when the name is lost by one owner and
17996 * claimed by another. However, if no name owner currently exists,
17997 * then calls will be sent to the well-known name which may result in
17998 * the message bus launching an owner (unless
17999 * %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set).
18000 * The generic #GDBusProxy::g-properties-changed and #GDBusProxy::g-signal
18001 * signals are not very convenient to work with. Therefore, the recommended
18002 * way of working with proxies is to subclass #GDBusProxy, and have
18003 * more natural properties and signals in your derived class.
18004 * See <xref linkend="gdbus-example-proxy-subclass"/> for an example.
18005 * <example id="gdbus-wellknown-proxy"><title>GDBusProxy for a well-known-name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-watch-proxy.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
18012 * The <structname>GSimpleAction</structname> structure contains private
18013 * data and should only be accessed using the provided API
18020 * g_socket_get_local_address:
18021 * @socket: a #GSocket.
18022 * @error: #GError for error reporting, or %NULL to ignore.
18024 * Try to get the local address of a bound socket. This is only
18025 * useful if the socket has been bound to a local address,
18026 * either explicitly or implicitly when connecting.
18027 * Free the returned object with g_object_unref().
18029 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
18036 * @g_iface: The parent interface.
18037 * @changed: Signal emitted when the drive is changed.
18038 * @disconnected: The removed signal that 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.
18039 * @eject_button: Signal emitted when the physical eject button (if any) of a drive have been pressed.
18040 * @get_name: Returns the name for the given #GDrive.
18041 * @get_icon: Returns a #GIcon for the given #GDrive.
18042 * @has_volumes: Returns %TRUE if the #GDrive has mountable volumes.
18043 * @get_volumes: Returns a list #GList of #GVolume for the #GDrive.
18044 * @is_media_removable: Returns %TRUE if the #GDrive supports removal and insertion of media.
18045 * @has_media: Returns %TRUE if the #GDrive has media inserted.
18046 * @is_media_check_automatic: Returns %TRUE if the #GDrive is capabable of automatically detecting media changes.
18047 * @can_poll_for_media: Returns %TRUE if the #GDrive is capable of manually polling for media change.
18048 * @can_eject: Returns %TRUE if the #GDrive can eject media.
18049 * @eject: Ejects a #GDrive.
18050 * @eject_finish: Finishes an eject operation.
18051 * @poll_for_media: Poll for media insertion/removal on a #GDrive.
18052 * @poll_for_media_finish: Finishes a media poll operation.
18053 * @get_identifier: Returns the identifier of the given kind, or %NULL if the #GDrive doesn't have one.
18054 * @enumerate_identifiers: Returns an array strings listing the kinds of identifiers which the #GDrive has.
18055 * @get_start_stop_type: Gets a #GDriveStartStopType with details about starting/stopping the drive. Since 2.22.
18056 * @can_stop: Returns %TRUE if a #GDrive can be stopped. Since 2.22.
18057 * @stop: Stops a #GDrive. Since 2.22.
18058 * @stop_finish: Finishes a stop operation. Since 2.22.
18059 * @can_start: Returns %TRUE if a #GDrive can be started. Since 2.22.
18060 * @can_start_degraded: Returns %TRUE if a #GDrive can be started degraded. Since 2.22.
18061 * @start: Starts a #GDrive. Since 2.22.
18062 * @start_finish: Finishes a start operation. Since 2.22.
18063 * @stop_button: Signal emitted when the physical stop button (if any) of a drive have been pressed. Since 2.22.
18064 * @eject_with_operation: Starts ejecting a #GDrive using a #GMountOperation. Since 2.22.
18065 * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
18067 * Interface for creating #GDrive implementations.
18072 * g_unix_output_stream_get_fd:
18073 * @stream: a #GUnixOutputStream
18075 * Return the UNIX file descriptor that the stream writes to.
18077 * Returns: The file descriptor of @stream
18083 * g_dbus_is_unique_name:
18084 * @string: The string to check.
18086 * Checks if @string is a valid D-Bus unique bus name.
18088 * Returns: %TRUE if valid, %FALSE otherwise.
18094 * G_FILE_ATTRIBUTE_UNIX_UID:
18096 * A key in the "unix" namespace for getting the user ID for the file.
18097 * This attribute is only available for UNIX file systems.
18098 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
18103 * g_inet_address_get_native_size:
18104 * @address: a #GInetAddress
18106 * Gets the size of the native raw binary address for @address. This
18107 * is the size of the data that you get from g_inet_address_to_bytes().
18109 * Returns: the number of bytes used for the native version of @address.
18116 * @object: Instance to check for being a %G_TYPE_OBJECT.
18118 * Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT.
18123 * g_file_query_info:
18124 * @file: input #GFile.
18125 * @attributes: an attribute query string.
18126 * @flags: a set of #GFileQueryInfoFlags.
18127 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
18128 * @error: a #GError.
18130 * Gets the requested information about specified @file. The result
18131 * is a #GFileInfo object that contains key-value attributes (such as
18132 * the type or size of the file).
18133 * The @attributes value is a string that specifies the file attributes that
18134 * should be gathered. It is not an error if it's not possible to read a particular
18135 * requested attribute from a file - it just won't be set. @attributes should
18136 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
18137 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
18138 * namespace. An example attribute query be "standard::*,owner::user".
18139 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
18140 * If @cancellable is not %NULL, then the operation can be cancelled by
18141 * triggering the cancellable object from another thread. If the operation
18142 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
18143 * For symlinks, normally the information about the target of the
18144 * symlink is returned, rather than information about the symlink itself.
18145 * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
18146 * information about the symlink itself will be returned. Also, for symlinks
18147 * that point to non-existing files the information about the symlink itself
18148 * will be returned.
18149 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
18150 * Other errors are possible too, and depend on what kind of filesystem the file is on.
18151 * Free the returned object with g_object_unref().
18153 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error.
18160 * Holds results information for an asynchronous operation,
18161 * usually passed directly to a asynchronous _finish() operation.
18166 * g_io_extension_point_implement:
18167 * @extension_point_name: the name of the extension point
18168 * @type: the #GType to register as extension
18169 * @extension_name: the name for the extension
18170 * @priority: the priority for the extension
18172 * Registers @type as extension for the extension point with name
18173 * If @type has already been registered as an extension for this
18174 * extension point, the existing #GIOExtension object is returned.
18176 * Returns: a #GIOExtension object for #GType
18181 * g_mount_eject_finish:
18182 * @mount: a #GMount.
18183 * @result: a #GAsyncResult.
18184 * @error: a #GError location to store the error occuring, or %NULL to ignore.
18186 * Finishes ejecting a mount. If any errors occurred during the operation,
18188 * Returns: %TRUE if the mount was successfully ejected. %FALSE otherwise.
18189 * Deprecated: 2.22: Use g_mount_eject_with_operation_finish() instead.
18194 * GUnixSocketAddress:
18196 * A UNIX-domain (local) socket address, corresponding to a
18197 * <type>struct sockaddr_un</type>.
18202 * g_file_info_get_attribute_status:
18203 * @info: a #GFileInfo
18204 * @attribute: a file attribute key
18206 * Gets the attribute status for an attribute key.
18207 * %G_FILE_ATTRIBUTE_STATUS_UNSET if the key is invalid.
18209 * Returns: a #GFileAttributeStatus for the given @attribute, or
18215 * @g_iface: The parent interface.
18216 * @changed: Changed signal that is emitted when the mount's state has changed.
18217 * @unmounted: The unmounted signal that 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.
18218 * @pre_unmount: The pre_unmout signal that is emitted when the #GMount will soon be emitted. If the recipient is somehow holding the mount open by keeping an open file on it it should close the file.
18219 * @get_root: Gets a #GFile to the root directory of the #GMount.
18220 * @get_name: Gets a string containing the name of the #GMount.
18221 * @get_icon: Gets a #GIcon for the #GMount.
18222 * @get_uuid: Gets the UUID for the #GMount. 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.
18223 * @get_volume: Gets a #GVolume the mount is located on. Returns %NULL if the #GMount is not associated with a #GVolume.
18224 * @get_drive: Gets a #GDrive the volume of the mount is located on. Returns %NULL if the #GMount is not associated with a #GDrive or a #GVolume. This is convenience method for getting the #GVolume and using that to get the #GDrive.
18225 * @can_unmount: Checks if a #GMount can be unmounted.
18226 * @can_eject: Checks if a #GMount can be ejected.
18227 * @unmount: Starts unmounting a #GMount.
18228 * @unmount_finish: Finishes an unmounting operation.
18229 * @eject: Starts ejecting a #GMount.
18230 * @eject_finish: Finishes an eject operation.
18231 * @remount: Starts remounting a #GMount.
18232 * @remount_finish: Finishes a remounting operation.
18233 * @guess_content_type: Starts guessing the type of the content of a #GMount. See g_mount_guess_content_type() for more information on content type guessing. This operation was added in 2.18.
18234 * @guess_content_type_finish: Finishes a contenet type guessing operation. Added in 2.18.
18235 * @guess_content_type_sync: Synchronous variant of @guess_content_type. Added in 2.18
18236 * @unmount_with_operation: Starts unmounting a #GMount using a #GMountOperation. Since 2.22.
18237 * @unmount_with_operation_finish: Finishes an unmounting operation using a #GMountOperation. Since 2.22.
18238 * @eject_with_operation: Starts ejecting a #GMount using a #GMountOperation. Since 2.22.
18239 * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
18240 * @get_default_location: Gets a #GFile indication a start location that can be use as the entry point for this mount. Since 2.24.
18242 * Interface for implementing operations for mounts.
18247 * GOutputStreamSpliceFlags:
18248 * @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream.
18249 * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after the splice.
18250 * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after the splice.
18252 * GOutputStreamSpliceFlags determine how streams should be spliced.
18257 * g_cancellable_get_fd:
18258 * @cancellable: a #GCancellable.
18260 * Gets the file descriptor for a cancellable job. This can be used to
18261 * implement cancellable operations on Unix systems. The returned fd will
18262 * turn readable when @cancellable is cancelled.
18263 * You are not supposed to read from the fd yourself, just check for
18264 * readable status. Reading to unset the readable status is done
18265 * with g_cancellable_reset().
18266 * After a successful return from this function, you should use
18267 * g_cancellable_release_fd() to free up resources allocated for
18268 * the returned file descriptor.
18269 * See also g_cancellable_make_pollfd().
18270 * is not supported, or on errors.
18272 * Returns: A valid file descriptor. %-1 if the file descriptor
18279 * A #GSocketConnectable for resolving a SRV record and connecting to
18285 * g_dbus_message_get_path:
18286 * @message: A #GDBusMessage.
18288 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
18290 * Returns: The value.
18296 * G_VALUE_HOLDS_DOUBLE:
18297 * @value: a valid #GValue structure
18299 * Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE.
18301 * Returns: %TRUE on success.
18306 * g_file_attribute_matcher_matches_only:
18307 * @matcher: a #GFileAttributeMatcher.
18308 * @attribute: a file attribute key.
18310 * Checks if a attribute matcher only matches a given attribute. Always
18311 * returns %FALSE if "*" was used when creating the matcher.
18313 * Returns: %TRUE if the matcher only matches @attribute. %FALSE otherwise.
18318 * g_drive_can_eject:
18319 * @drive: a #GDrive.
18321 * Checks if a drive can be ejected.
18323 * Returns: %TRUE if the @drive can be ejected, %FALSE otherwise.
18328 * SECTION:ginetaddres:
18329 * @short_description: An IPv4/IPv6 address
18331 * #GInetAddress represents an IPv4 or IPv6 internet address. Use
18332 * g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to
18333 * look up the #GInetAddress for a hostname. Use
18334 * g_resolver_lookup_by_address() or
18335 * g_resolver_lookup_by_address_async() to look up the hostname for a
18337 * To actually connect to a remote host, you will need a
18338 * #GInetSocketAddress (which includes a #GInetAddress as well as a
18344 * g_hash_table_thaw:
18345 * @hash_table: a #GHashTable
18347 * This function is deprecated and will be removed in the next major
18348 * release of GLib. It does nothing.
18353 * g_output_stream_close_finish:
18354 * @stream: a #GOutputStream.
18355 * @result: a #GAsyncResult.
18356 * @error: a #GError location to store the error occuring, or %NULL to ignore.
18358 * Closes an output stream.
18360 * Returns: %TRUE if stream was successfully closed, %FALSE otherwise.
18365 * g_dbus_message_bytes_needed:
18366 * @blob: A blob represent a binary D-Bus message.
18367 * @blob_len: The length of @blob (must be at least 16).
18368 * @error: Return location for error or %NULL.
18370 * Utility function to calculate how many bytes are needed to
18371 * completely deserialize the D-Bus message stored at @blob.
18372 * determine the size).
18374 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
18380 * g_socket_listener_accept_socket_async:
18381 * @listener: a #GSocketListener
18382 * @cancellable: (allow-none): a #GCancellable, or %NULL
18383 * @callback: (scope async): a #GAsyncReadyCallback
18384 * @user_data: (closure): user data for the callback
18386 * This is the asynchronous version of g_socket_listener_accept_socket().
18387 * When the operation is finished @callback will be
18388 * called. You can then call g_socket_listener_accept_socket_finish()
18389 * to get the result of the operation.
18396 * g_unix_credentials_message_new:
18398 * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
18400 * Returns: a new #GUnixCredentialsMessage
18406 * get_all_desktop_entries_for_mime_type:
18407 * @mime_type: a mime type.
18408 * @except: NULL or a strv list
18410 * Returns all the desktop ids for @mime_type. The desktop files
18411 * are listed in an order so that default applications are listed before
18412 * non-default ones, and handlers for inherited mimetypes are listed
18413 * after the base ones.
18414 * Optionally doesn't list the desktop ids given in the @except
18415 * to handle @mime_type.
18417 * Returns: a #GList containing the desktop ids which claim
18422 * G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI:
18424 * A key in the "mountable" namespace for getting the HAL UDI for the mountable
18425 * file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
18430 * G_VARIANT_TYPE_BYTESTRING_ARRAY:
18432 * The type of an array of byte strings (an array of arrays of bytes).
18437 * GPermission:allowed:
18439 * %TRUE if the caller currently has permission to perform the action that
18444 * g_application_command_line_get_platform_data:
18445 * @cmdline: #GApplicationCommandLine
18447 * Gets the platform data associated with the invocation of @cmdline.
18448 * This is a #GVariant dictionary containing information about the
18449 * context in which the invocation occured. It typically contains
18450 * information like the current working directory and the startup
18452 * For local invocation, it will be %NULL.
18454 * Returns: the platform data, or %NULL
18460 * g_file_info_set_symlink_target:
18461 * @info: a #GFileInfo.
18462 * @symlink_target: a static string containing a path to a symlink target.
18464 * Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info
18465 * to the given symlink target.
18470 * g_unix_mount_point_compare:
18471 * @mount1: a #GUnixMount.
18472 * @mount2: a #GUnixMount.
18474 * Compares two unix mount points.
18475 * or less than @mount2, respectively.
18477 * Returns: 1, 0 or -1 if @mount1 is greater than, equal to,
18482 * g_file_info_get_attribute_int32:
18483 * @info: a #GFileInfo.
18484 * @attribute: a file attribute key.
18486 * Gets a signed 32-bit integer contained within the attribute. If the
18487 * attribute does not contain a signed 32-bit integer, or is invalid,
18488 * 0 will be returned.
18490 * Returns: a signed 32-bit integer from the attribute.
18495 * g_unix_fd_list_steal_fds:
18496 * @list: a #GUnixFDList
18497 * @length: (out) (allow-none): pointer to the length of the returned array, or %NULL
18499 * Returns the array of file descriptors that is contained in this
18501 * After this call, the descriptors are no longer contained in
18502 * descriptors have been added).
18503 * The return result of this function must be freed with g_free().
18504 * The caller is also responsible for closing all of the file
18505 * descriptors. The file descriptors in the array are set to
18507 * If @length is non-%NULL then it is set to the number of file
18508 * descriptors in the returned array. The returned array is also
18509 * terminated with -1.
18510 * This function never returns %NULL. In case there are no file
18511 * descriptors contained in @list, an empty array is returned.
18514 * Returns: (array length=length) (transfer full): an array of file
18522 * A Volume Monitor that watches for volume events.
18527 * G_TIME_SPAN_HOUR:
18529 * Evaluates to a time span of one hour.
18536 * g_dbus_message_set_byte_order:
18537 * @message: A #GDBusMessage.
18538 * @byte_order: The byte order.
18540 * Sets the byte order of @message.
18547 * The #GType for a boxed type holding a %NULL-terminated array of strings.
18548 * The code fragments in the following example show the use of a property of
18549 * type #G_TYPE_STRV with g_object_class_install_property(), g_object_set()
18550 * and g_object_get().
18552 * g_object_class_install_property (object_class,
18554 * g_param_spec_boxed ("authors",
18556 * _("List of authors"),
18558 * G_PARAM_READWRITE));
18559 * gchar *authors[] = { "Owen", "Tim", NULL };
18560 * g_object_set (obj, "authors", authors, NULL);
18561 * gchar *writers[];
18562 * g_object_get (obj, "authors", &writers, NULL);
18563 * // do something with writers
18564 * g_strfreev (writers);
18572 * GDrive::disconnected:
18573 * @drive: a #GDrive.
18575 * This signal is emitted when the #GDrive have been
18576 * disconnected. If the recipient is holding references to the
18577 * object they should release them so the object can be
18583 * g_file_set_attribute_uint32:
18584 * @file: input #GFile.
18585 * @attribute: a string containing the attribute's name.
18586 * @value: a #guint32 containing the attribute's new value.
18587 * @flags: a #GFileQueryInfoFlags.
18588 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
18589 * @error: a #GError, or %NULL
18591 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
18592 * If @attribute is of a different type, this operation will fail.
18593 * If @cancellable is not %NULL, then the operation can be cancelled by
18594 * triggering the cancellable object from another thread. If the operation
18595 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
18596 * in the @file, %FALSE otherwise.
18598 * Returns: %TRUE if the @attribute was successfully set to @value
18603 * g_file_has_prefix:
18604 * @file: input #GFile.
18605 * @prefix: input #GFile.
18607 * Checks whether @file has the prefix specified by @prefix. In other word,
18608 * if the names of inital elements of @file<!-- -->s pathname match @prefix.
18609 * Only full pathname elements are matched, so a path like /foo is not
18610 * considered a prefix of /foobar, only of /foo/bar.
18611 * This call does no i/o, as it works purely on names. As such it can
18612 * sometimes return %FALSE even if @file is inside a @prefix (from a
18613 * filesystem point of view), because the prefix of @file is an alias
18615 * %FALSE otherwise.
18617 * Virtual: prefix_matches
18618 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix.
18623 * SECTION:gfileattribut:
18624 * @short_description: Key-Value Paired File Attributes
18625 * @include: gio/gio.h
18626 * @see_also: #GFile, #GFileInfo
18628 * File attributes in GIO consist of a list of key-value pairs.
18629 * Keys are strings that contain a key namespace and a key name, separated
18630 * by a colon, e.g. "namespace:keyname". Namespaces are included to sort
18631 * key-value pairs by namespaces for relevance. Keys can be retrived
18632 * using wildcards, e.g. "standard::*" will return all of the keys in the
18633 * "standard" namespace.
18634 * Values are stored within the list in #GFileAttributeValue structures.
18635 * Values can store different types, listed in the enum #GFileAttributeType.
18636 * Upon creation of a #GFileAttributeValue, the type will be set to
18637 * %G_FILE_ATTRIBUTE_TYPE_INVALID.
18638 * The list of possible attributes for a filesystem (pointed to by a #GFile) is
18639 * availible as a #GFileAttributeInfoList. This list is queryable by key names
18640 * as indicated earlier.
18641 * Classes that implement #GFileIface will create a #GFileAttributeInfoList and
18642 * install default keys and values for their given file system, architecture,
18643 * and other possible implementation details (e.g., on a UNIX system, a file
18644 * attribute key will be registered for the user id for a given file).
18647 * <title>GFileAttributes Default Namespaces</title>
18648 * <tgroup cols='2' align='left'><thead>
18649 * <row><entry>Namspace</entry><entry>Description</entry></row>
18652 * <row><entry>"standard"</entry><entry>The "Standard" namespace. General file
18653 * information that any application may need should be put in this namespace.
18654 * Examples include the file's name, type, and size.</entry></row>
18655 * <row><entry>"etag"</entry><entry>The <link linkend="gfile-etag">"Entity Tag"</link>
18656 * namespace. Currently, the only key in this namespace is "value", which contains
18657 * the value of the current entity tag.</entry></row>
18658 * <row><entry>"id"</entry><entry>The "Identification" namespace. This
18659 * namespace is used by file managers and applications that list directories
18660 * to check for loops and to uniquely identify files.</entry></row>
18661 * <row><entry>"access"</entry><entry>The "Access" namespace. Used to check
18662 * if a user has the proper privilidges to access files and perform
18663 * file operations. Keys in this namespace are made to be generic
18664 * and easily understood, e.g. the "can_read" key is %TRUE if
18665 * the current user has permission to read the file. UNIX permissions and
18666 * NTFS ACLs in Windows should be mapped to these values.</entry></row>
18667 * <row><entry>"mountable"</entry><entry>The "Mountable" namespace. Includes
18668 * simple boolean keys for checking if a file or path supports mount operations, e.g.
18669 * mount, unmount, eject. These are used for files of type %G_FILE_TYPE_MOUNTABLE.</entry></row>
18670 * <row><entry>"time"</entry><entry>The "Time" namespace. Includes file
18671 * access, changed, created times. </entry></row>
18672 * <row><entry>"unix"</entry><entry>The "Unix" namespace. Includes UNIX-specific
18673 * information and may not be available for all files. Examples include
18674 * the UNIX "UID", "GID", etc.</entry></row>
18675 * <row><entry>"dos"</entry><entry>The "DOS" namespace. Includes DOS-specific
18676 * information and may not be available for all files. Examples include
18677 * "is_system" for checking if a file is marked as a system file, and "is_archive"
18678 * for checking if a file is marked as an archive file.</entry></row>
18679 * <row><entry>"owner"</entry><entry>The "Owner" namespace. Includes information
18680 * about who owns a file. May not be available for all file systems. Examples include
18681 * "user" for getting the user name of the file owner. This information is often mapped from
18682 * some backend specific data such as a unix UID.</entry></row>
18683 * <row><entry>"thumbnail"</entry><entry>The "Thumbnail" namespace. Includes
18684 * information about file thumbnails and their location within the file system. Exaples of
18685 * keys in this namespace include "path" to get the location of a thumbnail, and "failed"
18686 * to check if thumbnailing of the file failed.</entry></row>
18687 * <row><entry>"filesystem"</entry><entry>The "Filesystem" namespace. Gets information
18688 * about the file system where a file is located, such as its type, how much
18689 * space is left available, and the overall size of the file system.</entry></row>
18690 * <row><entry>"gvfs"</entry><entry>The "GVFS" namespace. Keys in this namespace
18691 * contain information about the current GVFS backend in use. </entry></row>
18692 * <row><entry>"xattr"</entry><entry>The "xattr" namespace. Gets information
18693 * about extended user attributes. See attr(5). The "user." prefix of the
18694 * extended user attribute name is stripped away when constructing keys in
18695 * this namespace, e.g. "xattr::mime_type" for the extended attribute with
18696 * the name "user.mime_type". Note that this information is only available
18697 * if GLib has been built with extended attribute support.</entry></row>
18698 * <row><entry>"xattr-sys"</entry><entry>The "xattr-sys" namespace.
18699 * Gets information about extended attributes which are not user-specific.
18700 * See attr(5). Note that this information is only available if GLib
18701 * has been built with extended attribute support.</entry></row>
18702 * <row><entry>"selinux"</entry><entry>The "SELinux" namespace. Includes
18703 * information about the SELinux context of files. Note that this information
18704 * is only available if GLib has been built with SELinux support.</entry></row>
18709 * Please note that these are not all of the possible namespaces.
18710 * More namespaces can be added from GIO modules or by individual applications.
18711 * For more information about writing GIO modules, see #GIOModule.
18712 * <!-- TODO: Implementation note about using extended attributes on supported
18715 * <title>GFileAttributes Built-in Keys and Value Types</title>
18716 * <tgroup cols='3' align='left'><thead>
18717 * <row><entry>Enum Value</entry><entry>Namespace:Key</entry><entry>Value Type</entry></row>
18719 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TYPE</entry><entry>standard::type</entry><entry>uint32 (#GFileType)</entry></row>
18720 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN</entry><entry>standard::is-hidden</entry><entry>boolean</entry></row>
18721 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP</entry><entry>standard::is-backup</entry><entry>boolean</entry></row>
18722 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK</entry><entry>standard::is-symlink</entry><entry>boolean</entry></row>
18723 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL</entry><entry>standard::is-virtual</entry><entry>boolean</entry></row>
18724 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_NAME</entry><entry>standard::name</entry><entry>byte string</entry></row>
18725 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME</entry><entry>standard::display-name</entry><entry>string</entry></row>
18726 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME</entry><entry>standard::edit-name</entry><entry>string</entry></row>
18727 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_ICON</entry><entry>standard::icon</entry><entry>object (#GIcon)</entry></row>
18728 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE</entry><entry>standard::content-type</entry><entry>string</entry></row>
18729 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE</entry><entry>standard::fast-content-type</entry><entry>string</entry></row>
18730 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SIZE</entry><entry>standard::size</entry><entry>uint64</entry></row>
18731 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE</entry><entry>standard::allocated-size</entry><entry>uint64</entry></row>
18732 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET</entry><entry>standard::symlink-target</entry><entry>byte string</entry></row>
18733 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TARGET_URI</entry><entry>standard::target-uri</entry><entry>string</entry></row>
18734 * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER</entry><entry>standard::sort-order</entry><entry>int32</entry></row>
18735 * <row><entry>%G_FILE_ATTRIBUTE_ETAG_VALUE</entry><entry>etag::value</entry><entry>string</entry></row>
18736 * <row><entry>%G_FILE_ATTRIBUTE_ID_FILE</entry><entry>id::file</entry><entry>string</entry></row>
18737 * <row><entry>%G_FILE_ATTRIBUTE_ID_FILESYSTEM</entry><entry>id::filesystem</entry><entry>string</entry></row>
18738 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_READ</entry><entry>access::can-read</entry><entry>boolean</entry></row>
18739 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE</entry><entry>access::can-write</entry><entry>boolean</entry></row>
18740 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE</entry><entry>access::can-execute</entry><entry>boolean</entry></row>
18741 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE</entry><entry>access::can-delete</entry><entry>boolean</entry></row>
18742 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH</entry><entry>access::can-trash</entry><entry>boolean</entry></row>
18743 * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME</entry><entry>access::can-rename</entry><entry>boolean</entry></row>
18744 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT</entry><entry>mountable::can-mount</entry><entry>boolean</entry></row>
18745 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT</entry><entry>mountable::can-unmount</entry><entry>boolean</entry></row>
18746 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT</entry><entry>mountable::can-eject</entry><entry>boolean</entry></row>
18747 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE</entry><entry>mountable::unix-device</entry><entry>uint32</entry></row>
18748 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE</entry><entry>mountable::unix-device-file</entry><entry>string</entry></row>
18749 * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI</entry><entry>mountable::hal-udi</entry><entry>string</entry></row>
18750 * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED</entry><entry>time::modified</entry><entry>uint64</entry></row>
18751 * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC</entry><entry>time::modified-usec</entry><entry>uint32</entry></row>
18752 * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS</entry><entry>time::access</entry><entry>uint64</entry></row>
18753 * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS_USEC</entry><entry>time::access-usec</entry><entry>uint32</entry></row>
18754 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED</entry><entry>time::changed</entry><entry>uint64</entry></row>
18755 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED_USEC</entry><entry>time::changed-usec</entry><entry>uint32</entry></row>
18756 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED</entry><entry>time::created</entry><entry>uint64</entry></row>
18757 * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED_USEC</entry><entry>time::created-usec</entry><entry>uint32</entry></row>
18758 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_DEVICE</entry><entry>unix::device</entry><entry>uint32</entry></row>
18759 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_INODE</entry><entry>unix::inode</entry><entry>uint64</entry></row>
18760 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_MODE</entry><entry>unix::mode</entry><entry>uint32</entry></row>
18761 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_NLINK</entry><entry>unix::nlink</entry><entry>uint32</entry></row>
18762 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_UID</entry><entry>unix::uid</entry><entry>uint32</entry></row>
18763 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_GID</entry><entry>unix::gid</entry><entry>uint32</entry></row>
18764 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_RDEV</entry><entry>unix::rdev</entry><entry>uint32</entry></row>
18765 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE</entry><entry>unix::block-size</entry><entry>uint32</entry></row>
18766 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCKS</entry><entry>unix::blocks</entry><entry>uint64</entry></row>
18767 * <row><entry>%G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT</entry><entry>unix::is-mountpoint</entry><entry>boolean</entry></row>
18768 * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE</entry><entry>dos::is-archive</entry><entry>boolean</entry></row>
18769 * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_SYSTEM</entry><entry>dos::is-system</entry><entry>boolean</entry></row>
18770 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER</entry><entry>owner::user</entry><entry>string</entry></row>
18771 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER_REAL</entry><entry>owner::user-real</entry><entry>string</entry></row>
18772 * <row><entry>%G_FILE_ATTRIBUTE_OWNER_GROUP</entry><entry>owner::group</entry><entry>string</entry></row>
18773 * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAIL_PATH</entry><entry>thumbnail::path</entry><entry>bytestring</entry></row>
18774 * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAILING_FAILED</entry><entry>thumbnail::failed</entry><entry>boolean</entry></row>
18775 * <row><entry>%G_FILE_ATTRIBUTE_PREVIEW_ICON</entry><entry>preview::icon</entry><entry>object (#GIcon)</entry></row>
18776 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE</entry><entry>filesystem::size</entry><entry>uint64</entry></row>
18777 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_FREE</entry><entry>filesystem::free</entry><entry>uint64</entry></row>
18778 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_TYPE</entry><entry>filesystem::type</entry><entry>string</entry></row>
18779 * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_READONLY</entry><entry>filesystem::readonly</entry><entry>boolean</entry></row>
18780 * <row><entry>%G_FILE_ATTRIBUTE_GVFS_BACKEND</entry><entry>gvfs::backend</entry><entry>string</entry></row>
18781 * <row><entry>%G_FILE_ATTRIBUTE_SELINUX_CONTEXT</entry><entry>selinux::context</entry><entry>string</entry></row>
18782 * </tbody></tgroup></table></para>
18783 * Note that there are no predefined keys in the "xattr" and "xattr-sys"
18784 * namespaces. Keys for the "xattr" namespace are constructed by stripping
18785 * away the "user." prefix from the extended user attribute, and prepending
18786 * "xattr::". Keys for the "xattr-sys" namespace are constructed by
18787 * concatenating "xattr-sys::" with the extended attribute name. All extended
18788 * attribute values are returned as hex-encoded strings in which bytes outside
18789 * the ASCII range are encoded as hexadecimal escape sequences of the form
18790 * \x<replaceable>nn</replaceable>.
18795 * GUnixMountMonitor:
18797 * Watches #GUnixMount<!-- -->s for changes.
18803 * @drive: a #GDrive.
18804 * @flags: flags affecting the unmount if required for eject
18805 * @cancellable: optional #GCancellable object, %NULL to ignore.
18806 * @callback: a #GAsyncReadyCallback, or %NULL.
18807 * @user_data: user data to pass to @callback
18809 * Asynchronously ejects a drive.
18810 * When the operation is finished, @callback will be called.
18811 * You can then call g_drive_eject_finish() to obtain the
18812 * result of the operation.
18814 * Deprecated: 2.22: Use g_drive_eject_with_operation() instead.
18821 * The #GType for #GClosure.
18826 * GVolumeMonitor::drive-stop-button:
18827 * @volume_monitor: The volume monitor emitting the signal.
18828 * @drive: the drive where the stop button was pressed
18830 * Emitted when the stop button is pressed on @drive.
18837 * SECTION:gasynchelpe:
18838 * @short_description: Asynchronous Helper Functions
18839 * @include: gio/gio.h
18840 * @see_also: #GAsyncReady
18842 * Provides helper functions for asynchronous operations.
18847 * g_drive_get_start_stop_type:
18848 * @drive: a #GDrive.
18850 * Gets a hint about how a drive can be started/stopped.
18852 * Returns: A value from the #GDriveStartStopType enumeration.
18858 * g_dbus_connection_new_finish:
18859 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
18860 * @error: Return location for error or %NULL.
18862 * Finishes an operation started with g_dbus_connection_new().
18864 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
18871 * @bus_type: The type of bus to own a name on.
18872 * @name: The well-known name to own.
18873 * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
18874 * @bus_acquired_handler: Handler to invoke when connected to the bus of type @bus_type or %NULL.
18875 * @name_acquired_handler: Handler to invoke when @name is acquired or %NULL.
18876 * @name_lost_handler: Handler to invoke when @name is lost or %NULL.
18877 * @user_data: User data to pass to handlers.
18878 * @user_data_free_func: Function for freeing @user_data or %NULL.
18880 * Starts acquiring @name on the bus specified by @bus_type and calls
18881 * acquired respectively lost. Callbacks will be invoked in the <link
18882 * linkend="g-main-context-push-thread-default">thread-default main
18883 * loop</link> of the thread you are calling this function from.
18884 * You are guaranteed that one of the @name_acquired_handler and @name_lost_handler
18885 * callbacks will be invoked after calling this function - there are three
18889 * </para></listitem>
18891 * </para></listitem>
18893 * </para></listitem>
18895 * When you are done owning the name, just call g_bus_unown_name()
18896 * with the owner id this function returns.
18897 * If the name is acquired or lost (for example another application
18898 * could acquire the name if you allow replacement or the application
18899 * currently owning the name exits), the handlers are also invoked. If the
18900 * #GDBusConnection that is used for attempting to own the name
18901 * closes, then @name_lost_handler is invoked since it is no
18902 * longer possible for other processes to access the process.
18903 * You cannot use g_bus_own_name() several times for the same name (unless
18904 * interleaved with calls to g_bus_unown_name()) - only the first call
18906 * Another guarantee is that invocations of @name_acquired_handler
18907 * and @name_lost_handler are guaranteed to alternate; that
18908 * is, if @name_acquired_handler is invoked then you are
18909 * guaranteed that the next time one of the handlers is invoked, it
18910 * will be @name_lost_handler. The reverse is also true.
18911 * If you plan on exporting objects (using e.g.
18912 * g_dbus_connection_register_object()), note that it is generally too late
18913 * to export the objects in @name_acquired_handler. Instead, you can do this
18914 * in @bus_acquired_handler since you are guaranteed that this will run
18915 * before @name is requested from the bus.
18916 * This behavior makes it very simple to write applications that wants
18917 * to own names and export objects, see <xref linkend="gdbus-owning-names"/>.
18918 * Simply register objects to be exported in @bus_acquired_handler and
18919 * unregister the objects (if any) in @name_lost_handler.
18920 * g_bus_unown_name() to stop owning the name.
18922 * Returns: An identifier (never 0) that an be used with
18928 * g_dbus_message_get_error_name:
18929 * @message: A #GDBusMessage.
18931 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
18933 * Returns: The value.
18939 * GDBusProxy:g-name-owner:
18941 * The unique name that owns #GDBusProxy:name or %NULL if no-one
18942 * currently owns that name. You may connect to #GObject::notify signal to
18943 * track changes to this property.
18951 * @socket: a #GSocket
18952 * @error: #GError for error reporting, or %NULL to ignore.
18954 * Closes the socket, shutting down any active connection.
18955 * Closing a socket does not wait for all outstanding I/O operations
18956 * to finish, so the caller should not rely on them to be guaranteed
18957 * to complete even if the close returns with no error.
18958 * Once the socket is closed, all other operations will return
18959 * %G_IO_ERROR_CLOSED. Closing a socket multiple times will not
18961 * Sockets will be automatically closed when the last reference
18962 * is dropped, but you might want to call this function to make sure
18963 * resources are released as early as possible.
18964 * Beware that due to the way that TCP works, it is possible for
18965 * recently-sent data to be lost if either you close a socket while the
18966 * %G_IO_IN condition is set, or else if the remote connection tries to
18967 * send something to you after you close the socket but before it has
18968 * finished reading all of the data you sent. There is no easy generic
18969 * way to avoid this problem; the easiest fix is to design the network
18970 * protocol such that the client will never send data "out of turn".
18971 * Another solution is for the server to half-close the connection by
18972 * calling g_socket_shutdown() with only the @shutdown_write flag set,
18973 * and then wait for the client to notice this and close its side of the
18974 * connection, after which the server can safely call g_socket_close().
18975 * (This is what #GTcpConnection does if you call
18976 * g_tcp_connection_set_graceful_disconnect(). But of course, this
18977 * only works if the client will close its connection after the server
18980 * Returns: %TRUE on success, %FALSE on error
18986 * G_DEFINE_DYNAMIC_TYPE:
18987 * @TN: The name of the new type, in Camel case.
18988 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
18989 * @T_P: The #GType of the parent type.
18991 * A convenience macro for dynamic type implementations, which declares a
18992 * class initialization function, an instance initialization function (see
18993 * #GTypeInfo for information about these) and a static variable named
18994 * it defines a <function>*_get_type()</function> and a static
18995 * <function>*_register_type()</function> function for use in your
18996 * <function>module_init()</function>.
18997 * See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example.
19004 * G_FILE_ATTRIBUTE_DOS_IS_SYSTEM:
19006 * A key in the "dos" namespace for checking if the file's backup flag
19007 * is set. This attribute is %TRUE if the backup flag is set. This attribute
19008 * is only available for DOS file systems. Corresponding #GFileAttributeType
19009 * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
19016 * A <structname>GOptionGroup</structname> struct defines the options in a single
19017 * group. The struct has only private fields and should not be directly accessed.
19018 * All options in a group share the same translation function. Libraries which
19019 * need to parse commandline options are expected to provide a function for
19020 * getting a <structname>GOptionGroup</structname> holding their options, which
19021 * the application can then add to its #GOptionContext.
19026 * g_dbus_proxy_new_for_bus:
19027 * @bus_type: A #GBusType.
19028 * @flags: Flags used when constructing the proxy.
19029 * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
19030 * @name: A bus name (well-known or unique).
19031 * @object_path: An object path.
19032 * @interface_name: A D-Bus interface name.
19033 * @cancellable: A #GCancellable or %NULL.
19034 * @callback: Callback function to invoke when the proxy is ready.
19035 * @user_data: User data to pass to @callback.
19037 * Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection.
19038 * See <xref linkend="gdbus-wellknown-proxy"/> for an example of how #GDBusProxy can be used.
19045 * g_dbus_message_print:
19046 * @message: A #GDBusMessage.
19047 * @indent: Indentation level.
19049 * Produces a human-readable multi-line description of @message.
19050 * The contents of the description has no ABI guarantees, the contents
19051 * and formatting is subject to change at any time. Typical output
19052 * looks something like this:
19055 * path -> objectpath '/org/gtk/GDBus/TestObject'
19056 * interface -> 'org.gtk.GDBus.TestInterface'
19057 * member -> 'GimmeStdout'
19058 * destination -> ':1.146'
19059 * UNIX File Descriptors:
19061 * </programlisting>
19065 * reply-serial -> uint32 4
19066 * destination -> ':1.159'
19067 * sender -> ':1.146'
19068 * num-unix-fds -> uint32 1
19069 * UNIX File Descriptors:
19070 * </programlisting>
19072 * Type: method-return
19073 * Flags: no-reply-expected
19077 * Fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
19078 * Returns: A string that should be freed with g_free().
19084 * g_simple_async_result_set_error_va: (skip)
19085 * @simple: a #GSimpleAsyncResult.
19086 * @domain: a #GQuark (usually #G_IO_ERROR).
19087 * @code: an error code.
19088 * @format: a formatted error reporting string.
19089 * @args: va_list of arguments.
19091 * Sets an error within the asynchronous result without a #GError.
19092 * Unless writing a binding, see g_simple_async_result_set_error().
19097 * GBusAcquiredCallback:
19098 * @connection: The #GDBusConnection to a message bus.
19099 * @name: The name that is requested to be owned.
19100 * @user_data: User data passed to g_bus_own_name().
19102 * Invoked when a connection to a message bus has been obtained.
19109 * g_permission_get_allowed:
19110 * @permission: a #GPermission instance
19111 * @returns: the value of the 'allowed' property
19113 * Gets the value of the 'allowed' property. This property is %TRUE if
19114 * the caller currently has permission to perform the action that
19121 * G_VALUE_HOLDS_STRING:
19122 * @value: a valid #GValue structure
19124 * Checks whether the given #GValue can hold values of type %G_TYPE_STRING.
19126 * Returns: %TRUE on success.
19131 * g_app_info_get_fallback_for_type:
19132 * @content_type: the content type to find a #GAppInfo for
19134 * Gets a list of fallback #GAppInfos for a given content type, i.e.
19135 * those applications which claim to support the given content type
19136 * by MIME type subclassing and not directly.
19137 * for given @content_type or %NULL on error.
19139 * Returns: (element-type GAppInfo) (transfer full): #GList of #GAppInfos
19145 * G_VARIANT_TYPE_STRING:
19147 * The type of a string. "" is a string. %NULL is not a string.
19152 * G_FILE_ATTRIBUTE_UNIX_RDEV:
19154 * A key in the "unix" namespace for getting the device ID for the file
19155 * (if it is a special file). See lstat() documentation. This attribute
19156 * is only available for UNIX file systems. Corresponding #GFileAttributeType
19157 * is %G_FILE_ATTRIBUTE_TYPE_UINT32.
19162 * g_settings_get_mapped:
19163 * @settings: a #GSettings object
19164 * @key: the key to get the value for
19165 * @mapping: the function to map the value in the settings database to the value used by the application
19166 * @user_data: user data for @mapping
19167 * @returns: (transfer full): the result, which may be %NULL
19169 * Gets the value that is stored at @key in @settings, subject to
19170 * application-level validation/mapping.
19171 * You should use this function when the application needs to perform
19172 * some processing on the value of the key (for example, parsing). The
19173 * indicates that the processing was unsuccessful (due to a parse error,
19174 * for example) then the mapping is tried again with another value.
19175 * This allows a robust 'fall back to defaults' behaviour to be
19176 * implemented somewhat automatically.
19177 * The first value that is tried is the user's setting for the key. If
19178 * the mapping function fails to map this value, other values may be
19179 * tried in an unspecified order (system or site defaults, translated
19180 * schema default values, untranslated schema default values, etc).
19181 * If the mapping function fails for all possible values, one additional
19182 * If the mapping function still indicates failure at this point then
19183 * the application will be aborted.
19184 * The result parameter for the @mapping function is pointed to a
19185 * #gpointer which is initially set to %NULL. The same pointer is given
19186 * to each invocation of @mapping. The final value of that #gpointer is
19187 * what is returned by this function. %NULL is valid; it is returned
19188 * just as any other value would be.
19190 * Attempt is made: the mapping function is called with a %NULL value.
19195 * g_srv_target_get_priority:
19196 * @target: a #GSrvTarget
19198 * Gets @target's priority. You should not need to look at this;
19199 * #GResolver already sorts the targets according to the algorithm in
19202 * Returns: @target's priority
19208 * GActionGroup::action-state-changed:
19209 * @action_group: the #GActionGroup that changed
19210 * @action_name: the name of the action in @action_group
19211 * @value: the new value of the state
19213 * Signals that the state of the named action has changed.
19221 * @g_iface: The parent interface.
19222 * @dup: Copies a #GAppInfo.
19223 * @equal: Checks two #GAppInfo<!-- -->s for equality.
19224 * @get_id: Gets a string identifier for a #GAppInfo.
19225 * @get_name: Gets the name of the application for a #GAppInfo.
19226 * @get_description: Gets a short description for the application described by the #GAppInfo.
19227 * @get_executable: Gets the executable name for the #GAppInfo.
19228 * @get_icon: Gets the #GIcon for the #GAppInfo.
19229 * @launch: Launches an application specified by the #GAppInfo.
19230 * @supports_uris: Indicates whether the application specified supports launching URIs.
19231 * @supports_files: Indicates whether the application specified accepts filename arguments.
19232 * @launch_uris: Launches an application with a list of URIs.
19233 * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications). <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt"> <citetitle>FreeDesktop.Org Startup Notification Specification</citetitle></ulink>.
19234 * @set_as_default_for_type: Sets an application as default for a given content type.
19235 * @set_as_default_for_extension: Sets an application as default for a given file extension.
19236 * @add_supports_type: Adds to the #GAppInfo information about supported file types.
19237 * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
19238 * @remove_supports_type: Removes a supported application type from a #GAppInfo.
19239 * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
19240 * @do_delete: Deletes a #GAppInfo. Since 2.20
19241 * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
19242 * @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
19244 * Application Information interface, for operating system portability.
19249 * g_mount_operation_get_choice:
19250 * @op: a #GMountOperation.
19252 * Gets a choice from the mount operation.
19253 * the choice's list, or %0.
19255 * Returns: an integer containing an index of the user's choice from
19260 * g_zlib_decompressor_new:
19261 * @format: The format to use for the compressed data
19263 * Creates a new #GZlibDecompressor.
19265 * Returns: a new #GZlibDecompressor
19271 * g_network_service_get_scheme:
19272 * @srv: a #GNetworkService
19274 * Get's the URI scheme used to resolve proxies. By default, the service name
19275 * is used as scheme.
19277 * Returns: @srv's scheme name
19283 * g_tls_certificate_get_issuer:
19284 * @cert: a #GTlsCertificate
19286 * Gets the #GTlsCertificate representing @cert's issuer, if known
19287 * or %NULL if @cert is self-signed or signed with an unknown
19290 * Returns: (transfer none): The certificate of @cert's issuer,
19296 * g_dbus_proxy_set_cached_property:
19297 * @proxy: A #GDBusProxy
19298 * @property_name: Property name.
19299 * @value: Value for the property or %NULL to remove it from the cache.
19301 * If @value is not %NULL, sets the cached value for the property with
19302 * name @property_name to the value in @value.
19303 * If @value is %NULL, then the cached value is removed from the
19305 * If @proxy has an expected interface (see
19306 * #GDBusProxy:g-interface-info), then @property_name (for existence)
19307 * and @value (for the type) is checked against it.
19308 * If the @value #GVariant is floating, it is consumed. This allows
19309 * convenient 'inline' use of g_variant_new(), e.g.
19311 * g_dbus_proxy_set_cached_property (proxy,
19313 * g_variant_new ("(si)",
19317 * Normally you will not need to use this method since @proxy is
19318 * tracking changes using the
19319 * <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
19320 * D-Bus signal. However, for performance reasons an object may decide
19321 * to not use this signal for some properties and instead use a
19322 * proprietary out-of-band mechanism to transmit changes.
19323 * As a concrete example, consider an object with a property
19324 * <literal>ChatroomParticipants</literal> which is an array of
19325 * strings. Instead of transmitting the same (long) array every time
19326 * the property changes, it is more efficient to only transmit the
19327 * delta using e.g. signals <literal>ChatroomParticipantJoined(String
19328 * name)</literal> and <literal>ChatroomParticipantParted(String
19336 * g_simple_async_result_set_handle_cancellation:
19337 * @simple: a #GSimpleAsyncResult.
19338 * @handle_cancellation: a #gboolean.
19340 * Sets whether to handle cancellation within the asynchronous operation.
19345 * g_file_unmount_mountable_with_operation_finish:
19346 * @file: input #GFile.
19347 * @result: a #GAsyncResult.
19348 * @error: a #GError, or %NULL
19350 * Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
19351 * Finish an asynchronous unmount operation that was started
19352 * with g_file_unmount_mountable_with_operation().
19355 * Returns: %TRUE if the operation finished successfully. %FALSE
19361 * g_unix_fd_message_append_fd:
19362 * @message: a #GUnixFDMessage
19363 * @fd: a valid open file descriptor
19364 * @error: a #GError pointer
19366 * Adds a file descriptor to @message.
19367 * The file descriptor is duplicated using dup(). You keep your copy
19368 * of the descriptor and the copy contained in @message will be closed
19369 * when @message is finalized.
19370 * A possible cause of failure is exceeding the per-process or
19371 * system-wide file descriptor limit.
19373 * Returns: %TRUE in case of success, else %FALSE (and @error is set)
19379 * g_dbus_method_invocation_return_value:
19380 * @invocation: A #GDBusMethodInvocation.
19381 * @parameters: A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters.
19383 * Finishes handling a D-Bus method call by returning @parameters.
19384 * If the @parameters GVariant is floating, it is consumed.
19385 * It is an error if @parameters is not of the right format.
19386 * This method will free @invocation, you cannot use it afterwards.
19395 * A socket endpoint address, corresponding to <type>struct sockaddr</type>
19396 * or one of its subtypes.
19401 * g_io_stream_close_finish:
19402 * @stream: a #GIOStream
19403 * @result: a #GAsyncResult
19404 * @error: a #GError location to store the error occuring, or %NULL to ignore
19408 * Returns: %TRUE if stream was successfully closed, %FALSE otherwise.
19414 * g_socket_connection_factory_lookup_type:
19415 * @family: a #GSocketFamily
19416 * @type: a #GSocketType
19417 * @protocol_id: a protocol id
19419 * Looks up the #GType to be used when creating socket connections on
19420 * sockets with the specified @family,@type and @protocol_id.
19421 * If no type is registered, the #GSocketConnection base type is returned.
19423 * Returns: a #GType
19429 * g_tls_connection_get_peer_certificate_errors:
19430 * @conn: a #GTlsConnection
19432 * Gets the errors associated with validating @conn's peer's
19433 * certificate, after the handshake has completed. (It is not set
19434 * during the emission of #GTlsConnection::accept-certificate.)
19436 * Returns: @conn's peer's certificate errors
19442 * g_file_load_partial_contents_async: (skip)
19443 * @file: input #GFile.
19444 * @cancellable: optional #GCancellable object, %NULL to ignore.
19445 * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
19446 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
19447 * @user_data: the data to pass to the callback functions.
19449 * Reads the partial contents of a file. A #GFileReadMoreCallback should be
19450 * used to stop reading from the file when appropriate, else this function
19451 * will behave exactly as g_file_load_contents_async(). This operation
19452 * can be finished by g_file_load_partial_contents_finish().
19453 * Users of this function should be aware that @user_data is passed to
19454 * both the @read_more_callback and the @callback.
19455 * If @cancellable is not %NULL, then the operation can be cancelled by
19456 * triggering the cancellable object from another thread. If the operation
19457 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
19462 * g_io_stream_is_closed:
19463 * @stream: a #GIOStream
19465 * Checks if a stream is closed.
19467 * Returns: %TRUE if the stream is closed.
19473 * g_inet_address_get_is_loopback:
19474 * @address: a #GInetAddress
19476 * Tests whether @address is the loopback address for its family.
19478 * Returns: %TRUE if @address is the loopback address for its family.
19484 * g_file_get_parent:
19485 * @file: input #GFile.
19487 * Gets the parent directory for the @file.
19488 * If the @file represents the root directory of the
19489 * file system, then %NULL will be returned.
19490 * This call does no blocking i/o.
19491 * #GFile or %NULL if there is no parent.
19492 * Free the returned object with g_object_unref().
19494 * Returns: (transfer full): a #GFile structure to the parent of the given
19499 * g_application_get_is_registered:
19500 * @application: a #GApplication
19501 * @returns: %TRUE if @application is registered
19503 * Checks if @application is registered.
19504 * An application is registered if g_application_register() has been
19505 * successfully called.
19512 * G_TYPE_MAKE_FUNDAMENTAL:
19513 * @x: the fundamental type number.
19515 * Get the type ID for the fundamental type number @x.
19516 * Use g_type_fundamental_next() instead of this macro to create new fundamental
19519 * Returns: the GType
19524 * GSocketSourceFunc:
19525 * @socket: the #GSocket
19526 * @condition: the current condition at the source fired.
19527 * @user_data: data passed in by the user.
19529 * This is the function type of the callback used for the #GSource
19530 * returned by g_socket_create_source().
19532 * Returns: it should return %FALSE if the source should be removed.
19538 * G_DEFINE_DYNAMIC_TYPE_EXTENDED:
19539 * @TypeName: The name of the new type, in Camel case.
19540 * @type_name: The name of the new type, in lowercase, with words separated by '_'.
19541 * @TYPE_PARENT: The #GType of the parent type.
19542 * @flags: #GTypeFlags to pass to g_type_module_register_type()
19543 * @CODE: Custom code that gets inserted in the *_get_type() function.
19545 * A more general version of G_DEFINE_DYNAMIC_TYPE() which
19546 * allows to specify #GTypeFlags and custom code.
19548 * G_DEFINE_DYNAMIC_TYPE_EXTENDED (GtkGadget,
19552 * G_IMPLEMENT_INTERFACE_DYNAMIC (TYPE_GIZMO,
19553 * gtk_gadget_gizmo_init));
19557 * static void gtk_gadget_init (GtkGadget *self);
19558 * static void gtk_gadget_class_init (GtkGadgetClass *klass);
19559 * static void gtk_gadget_class_finalize (GtkGadgetClass *klass);
19560 * static gpointer gtk_gadget_parent_class = NULL;
19561 * static GType gtk_gadget_type_id = 0;
19562 * static void gtk_gadget_class_intern_init (gpointer klass)
19564 * gtk_gadget_parent_class = g_type_class_peek_parent (klass);
19565 * gtk_gadget_class_init ((GtkGadgetClass*) klass);
19568 * gtk_gadget_get_type (void)
19570 * return gtk_gadget_type_id;
19573 * gtk_gadget_register_type (GTypeModule *type_module)
19575 * const GTypeInfo g_define_type_info = {
19576 * sizeof (GtkGadgetClass),
19577 * (GBaseInitFunc) NULL,
19578 * (GBaseFinalizeFunc) NULL,
19579 * (GClassInitFunc) gtk_gadget_class_intern_init,
19580 * (GClassFinalizeFunc) gtk_gadget_class_finalize,
19581 * NULL, // class_data
19582 * sizeof (GtkGadget),
19583 * 0, // n_preallocs
19584 * (GInstanceInitFunc) gtk_gadget_init,
19585 * NULL // value_table
19587 * gtk_gadget_type_id = g_type_module_register_type (type_module,
19590 * &g_define_type_info,
19591 * (GTypeFlags) flags);
19593 * const GInterfaceInfo g_implement_interface_info = {
19594 * (GInterfaceInitFunc) gtk_gadget_gizmo_init
19596 * g_type_module_add_interface (type_module, g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
19606 * g_file_parse_name:
19607 * @parse_name: a file name or path to be parsed.
19609 * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
19610 * This operation never fails, but the returned object might not support any I/O
19611 * operation if the @parse_name cannot be parsed.
19613 * Returns: (transfer full): a new #GFile.
19618 * g_simple_async_result_is_valid:
19619 * @result: the #GAsyncResult passed to the _finish function.
19620 * @source: the #GObject passed to the _finish function.
19621 * @source_tag: the asynchronous function.
19623 * Ensures that the data passed to the _finish function of an async
19624 * operation is consistent. Three checks are performed.
19625 * First, @result is checked to ensure that it is really a
19626 * #GSimpleAsyncResult. Second, @source is checked to ensure that it
19627 * matches the source object of @result. Third, @source_tag is
19628 * checked to ensure that it is either %NULL (as it is when the result was
19629 * created by g_simple_async_report_error_in_idle() or
19630 * g_simple_async_report_gerror_in_idle()) or equal to the
19631 * convention, is a pointer to the _async function corresponding to the
19632 * _finish function from which this function is called).
19634 * Returns: #TRUE if all checks passed or #FALSE if any failed.
19640 * GTlsClientConnection:
19642 * TLS client-side connection; the client-side implementation of a
19650 * GDBusInterfaceGetPropertyFunc:
19651 * @connection: A #GDBusConnection.
19652 * @sender: The unique bus name of the remote caller.
19653 * @object_path: The object path that the method was invoked on.
19654 * @interface_name: The D-Bus interface name for the property.
19655 * @property_name: The name of the property to get the value of.
19656 * @error: Return location for error.
19657 * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
19659 * The type of the @get_property function in #GDBusInterfaceVTable.
19660 * consumed - otherwise its reference count is decreased by one.
19662 * Returns: A #GVariant with the value for @property_name or %NULL if
19668 * g_action_get_parameter_type:
19669 * @action: a #GAction
19671 * Queries the type of the parameter that must be given when activating
19672 * When activating the action using g_action_activate(), the #GVariant
19673 * given to that function must be of the type returned by this function.
19674 * In the case that this function returns %NULL, you must not give any
19675 * #GVariant, but %NULL instead.
19677 * Returns: (allow-none): the parameter type
19683 * g_dbus_connection_get_exit_on_close:
19684 * @connection: A #GDBusConnection.
19686 * Gets whether the process is terminated when @connection is
19687 * closed by the remote peer. See
19688 * #GDBusConnection:exit-on-close for more details.
19689 * closed by the remote peer.
19691 * Returns: Whether the process is terminated when @connection is
19697 * GTlsCertificateFlags:
19698 * @G_TLS_CERTIFICATE_UNKNOWN_CA: The signing certificate authority is not known.
19699 * @G_TLS_CERTIFICATE_BAD_IDENTITY: The certificate does not match the expected identity of the site that it was retrieved from.
19700 * @G_TLS_CERTIFICATE_NOT_ACTIVATED: The certificate's activation time is still in the future
19701 * @G_TLS_CERTIFICATE_EXPIRED: The certificate has expired
19702 * @G_TLS_CERTIFICATE_REVOKED: The certificate has been revoked according to the #GTlsContext's certificate revocation list.
19703 * @G_TLS_CERTIFICATE_INSECURE: The certificate's algorithm is considered insecure.
19704 * @G_TLS_CERTIFICATE_GENERIC_ERROR: Some other error occurred validating the certificate
19705 * @G_TLS_CERTIFICATE_VALIDATE_ALL: the combination of all of the above flags
19707 * A set of flags describing TLS certification validation. This can be
19708 * used to set which validation steps to perform (eg, with
19709 * g_tls_client_connection_set_validation_flags()), or to describe why
19710 * a particular certificate was rejected (eg, in
19711 * #GTlsConnection::accept-certificate).
19718 * GActionInterface:
19719 * @get_name: the virtual function pointer for g_action_get_name()
19720 * @get_parameter_type: the virtual function pointer for g_action_get_parameter_type()
19721 * @get_state_type: the virtual function pointer for g_action_get_state_type()
19722 * @get_state_hint: the virtual function pointer for g_action_get_state_hint()
19723 * @get_enabled: the virtual function pointer for g_action_get_enabled()
19724 * @get_state: the virtual function pointer for g_action_get_state()
19725 * @set_state: the virtual function pointer for g_action_set_state()
19726 * @activate: the virtual function pointer for g_action_activate(). Note that #GAction does not have an 'activate' signal but that implementations of it may have one.
19737 * Gets the local #GVfs for the system.
19739 * Returns: (transfer none): a #GVfs.
19745 * @parent_instance: private #GParamSpec portion
19747 * A #GParamSpec derived structure that contains the meta data for boxed properties.
19752 * g_atomic_int_dec_and_test:
19753 * @atomic: a pointer to an integer
19755 * Atomically decrements the integer pointed to by @atomic by 1.
19756 * after decrementing it
19758 * Returns: %TRUE if the integer pointed to by @atomic is 0
19764 * g_dbus_message_get_signature:
19765 * @message: A #GDBusMessage.
19767 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
19769 * Returns: The value.
19775 * g_file_info_get_attribute_data:
19776 * @info: a #GFileInfo
19777 * @attribute: a file attribute key
19778 * @type: (out) (allow-none): return location for the attribute type, or %NULL
19779 * @value_pp: (out) (allow-none): return location for the attribute value, or %NULL
19780 * @status: (out) (allow-none): return location for the attribute status, or %NULL
19782 * Gets the attribute type, value and status for an attribute key.
19783 * %FALSE otherwise.
19785 * Returns: (transfer none): %TRUE if @info has an attribute named @attribute,
19790 * SECTION:gsrvtarge:
19791 * @short_description: DNS SRV record target
19792 * @include: gio/gio.h
19794 * SRV (service) records are used by some network protocols to provide
19795 * service-specific aliasing and load-balancing. For example, XMPP
19796 * (Jabber) uses SRV records to locate the XMPP server for a domain;
19797 * rather than connecting directly to "example.com" or assuming a
19798 * specific server hostname like "xmpp.example.com", an XMPP client
19799 * would look up the "xmpp-client" SRV record for "example.com", and
19800 * then connect to whatever host was pointed to by that record.
19801 * You can use g_resolver_lookup_service() or
19802 * g_resolver_lookup_service_async() to find the #GSrvTarget<!-- -->s
19803 * for a given service. However, if you are simply planning to connect
19804 * to the remote service, you can use #GNetworkService's
19805 * #GSocketConnectable interface and not need to worry about
19806 * #GSrvTarget at all.
19811 * g_proxy_resolver_is_supported:
19812 * @resolver: a #GProxyResolver
19814 * Checks if @resolver can be used on this system. (This is used
19815 * internally; g_proxy_resolver_get_default() will only return a proxy
19816 * resolver that returns %TRUE for this method.)
19818 * Returns: %TRUE if @resolver is supported.
19824 * GSettings::writable-change-event:
19825 * @settings: the object on which the signal was emitted
19826 * @key: the quark of the key, or 0
19827 * @returns: %TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.
19829 * The "writable-change-event" signal is emitted once per writability
19830 * change event that affects this settings object. You should connect
19831 * to this signal if you are interested in viewing groups of changes
19832 * before they are split out into multiple emissions of the
19833 * "writable-changed" signal. For most use cases it is more
19834 * appropriate to use the "writable-changed" signal.
19835 * In the event that the writability change applies only to a single
19836 * key, @key will be set to the #GQuark for that key. In the event
19837 * that the writability change affects the entire settings object,
19838 * The default handler for this signal invokes the "writable-changed"
19839 * and "changed" signals for each affected key. This is done because
19840 * changes in writability might also imply changes in value (if for
19841 * example, a new mandatory setting is introduced). If any other
19842 * connected handler returns %TRUE then this default functionality
19843 * will be supressed.
19850 * A generic error; "something went wrong" - see the error message for
19852 * There was not enough memory to complete an operation.
19853 * The bus doesn't know how to launch a service to supply the bus name
19855 * The bus name you referenced doesn't exist (i.e. no application owns
19857 * No reply to a message expecting one, usually means a timeout occurred.
19858 * Something went wrong reading or writing to a socket, for example.
19859 * A D-Bus bus address was malformed.
19860 * Requested operation isn't supported (like ENOSYS on UNIX).
19861 * Some limited resource is exhausted.
19862 * Security restrictions don't allow doing what you're trying to do.
19863 * Authentication didn't work.
19864 * Unable to connect to server (probably caused by ECONNREFUSED on a
19866 * Certain timeout errors, possibly ETIMEDOUT on a socket. Note that
19867 * %G_DBUS_ERROR_NO_REPLY is used for message reply timeouts. Warning:
19868 * this is confusingly-named given that %G_DBUS_ERROR_TIMED_OUT also
19869 * exists. We can't fix it for compatibility reasons so just be
19871 * No network access (probably ENETUNREACH on a socket).
19872 * Can't bind a socket since its address is in use (i.e. EADDRINUSE).
19873 * The connection is disconnected and you're trying to use it.
19874 * Invalid arguments passed to a method call.
19876 * Existing file and the operation you're using does not silently overwrite.
19877 * Method name you invoked isn't known by the object you invoked it on.
19878 * confusingly-named given that %G_DBUS_ERROR_TIMEOUT also exists. We
19879 * can't fix it for compatibility reasons so just be careful.
19880 * Tried to remove or modify a match rule that didn't exist.
19881 * The match rule isn't syntactically valid.
19882 * While starting a new process, the exec() call failed.
19883 * While starting a new process, the fork() call failed.
19884 * While starting a new process, the child exited with a status code.
19885 * While starting a new process, the child exited on a signal.
19886 * While starting a new process, something went wrong.
19887 * We failed to setup the environment correctly.
19888 * We failed to setup the config parser correctly.
19889 * Bus name was not valid.
19890 * Service file not found in system-services directory.
19891 * Permissions are incorrect on the setuid helper.
19892 * Service file invalid (Name, User or Exec missing).
19893 * Tried to get a UNIX process ID and it wasn't available.
19894 * Tried to get a UNIX process ID and it wasn't available.
19895 * A type signature is not valid.
19896 * A file contains invalid syntax or is otherwise broken.
19897 * Asked for SELinux security context and it wasn't available.
19898 * Asked for ADT audit data and it wasn't available.
19899 * There's already an object with the requested object path.
19900 * Error codes for the %G_DBUS_ERROR error domain.
19902 * Certain timeout errors, e.g. while starting a service. warning: this is
19908 * g_socket_get_keepalive:
19909 * @socket: a #GSocket.
19911 * Gets the keepalive mode of the socket. For details on this,
19912 * see g_socket_set_keepalive().
19914 * Returns: %TRUE if keepalive is active, %FALSE otherwise.
19920 * g_dbus_generate_guid:
19922 * Generate a D-Bus GUID that can be used with
19923 * e.g. g_dbus_connection_new().
19924 * See the D-Bus specification regarding what strings are valid D-Bus
19925 * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
19927 * Returns: A valid D-Bus GUID. Free with g_free().
19934 * @short_description: Interface for icons
19935 * @include: gio/gio.h
19937 * #GIcon is a very minimal interface for icons. It provides functions
19938 * for checking the equality of two icons, hashing of icons and
19939 * serializing an icon to and from strings.
19940 * #GIcon does not provide the actual pixmap for the icon as this is out
19941 * of GIO's scope, however implementations of #GIcon may contain the name
19942 * of an icon (see #GThemedIcon), or the path to an icon (see #GLoadableIcon).
19943 * To obtain a hash of a #GIcon, see g_icon_hash().
19944 * To check if two #GIcons are equal, see g_icon_equal().
19945 * For serializing a #GIcon, use g_icon_to_string() and
19946 * g_icon_new_for_string().
19947 * If your application or library provides one or more #GIcon
19948 * implementations you need to ensure that each #GType is registered
19949 * with the type system prior to calling g_icon_new_for_string().
19955 * @G_SIGNAL_RUN_FIRST: Invoke the object method handler in the first emission stage.
19956 * @G_SIGNAL_RUN_LAST: Invoke the object method handler in the third emission stage.
19957 * @G_SIGNAL_RUN_CLEANUP: Invoke the object method handler in the last emission stage.
19958 * @G_SIGNAL_NO_RECURSE: 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.
19959 * @G_SIGNAL_DETAILED: This signal supports "::detail" appendices to the signal name upon handler connections and emissions.
19960 * @G_SIGNAL_ACTION: 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 of as object methods which can be called generically by third-party code.
19961 * @G_SIGNAL_NO_HOOKS: No emissions hooks are supported for this signal.
19963 * The signal flags are used to specify a signal's behaviour, the overall
19964 * signal description outlines how especially the RUN flags control the
19965 * stages of a signal emission.
19970 * g_socket_receive:
19971 * @socket: a #GSocket
19972 * @buffer: a buffer to read data into (which should be at least @size bytes long).
19973 * @size: the number of bytes you want to read from the socket
19974 * @cancellable: (allow-none): a %GCancellable or %NULL
19975 * @error: #GError for error reporting, or %NULL to ignore.
19977 * Receive data (up to @size bytes) from a socket. This is mainly used by
19978 * connection-oriented sockets; it is identical to g_socket_receive_from()
19979 * with @address set to %NULL.
19980 * For %G_SOCKET_TYPE_DATAGRAM and %G_SOCKET_TYPE_SEQPACKET sockets,
19981 * g_socket_receive() will always read either 0 or 1 complete messages from
19982 * the socket. If the received message is too large to fit in @buffer, then
19983 * the data beyond @size bytes will be discarded, without any explicit
19984 * indication that this has occurred.
19985 * For %G_SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any
19986 * number of bytes, up to @size. If more than @size bytes have been
19987 * received, the additional data will be returned in future calls to
19988 * g_socket_receive().
19989 * If the socket is in blocking mode the call will block until there is
19990 * some data to receive or there is an error. If there is no data available
19991 * and the socket is in non-blocking mode, a %G_IO_ERROR_WOULD_BLOCK error
19992 * will be returned. To be notified when data is available, wait for the
19993 * %G_IO_IN condition.
19994 * On error -1 is returned and @error is set accordingly.
19996 * Returns: Number of bytes read, or -1 on error
20002 * g_dbus_message_set_unix_fd_list:
20003 * @message: A #GDBusMessage.
20004 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
20006 * Sets the UNIX file descriptors associated with @message. As a
20007 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
20008 * field is set to the number of fds in @fd_list (or cleared if
20009 * This method is only available on UNIX.
20016 * g_socket_connect:
20017 * @socket: a #GSocket.
20018 * @address: a #GSocketAddress specifying the remote address.
20019 * @cancellable: (allow-none): a %GCancellable or %NULL
20020 * @error: #GError for error reporting, or %NULL to ignore.
20022 * Connect the socket to the specified remote address.
20023 * For connection oriented socket this generally means we attempt to make
20024 * a connection to the @address. For a connection-less socket it sets
20025 * the default address for g_socket_send() and discards all incoming datagrams
20026 * from other sources.
20027 * Generally connection oriented sockets can only connect once, but
20028 * connection-less sockets can connect multiple times to change the
20030 * If the connect call needs to do network I/O it will block, unless
20031 * non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned
20032 * and the user can be notified of the connection finishing by waiting
20033 * for the G_IO_OUT condition. The result of the connection can then be
20034 * checked with g_socket_check_connect_result().
20036 * Returns: %TRUE if connected, %FALSE on error.
20044 * The #GDBusProxy structure contains only private data and
20045 * should only be accessed using the provided API.
20052 * g_file_read_async:
20053 * @file: input #GFile
20054 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
20055 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
20056 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
20057 * @user_data: (closure): the data to pass to callback function
20059 * Asynchronously opens @file for reading.
20060 * For more details, see g_file_read() which is
20061 * the synchronous version of this call.
20062 * When the operation is finished, @callback will be called. You can then call
20063 * g_file_read_finish() to get the result of the operation.
20068 * g_dbus_server_get_flags:
20069 * @server: A #GDBusServer.
20071 * Gets the flags for @server.
20073 * Returns: A set of flags from the #GDBusServerFlags enumeration.
20079 * GMemoryOutputStream:data:
20081 * Pointer to buffer where data will be written.
20088 * g_settings_list_relocatable_schemas:
20090 * Gets a list of the relocatable #GSettings schemas installed on the
20091 * system. These are schemas that do not provide their own path. It is
20092 * usual to instantiate these schemas directly, but if you want to you
20093 * can use g_settings_new_with_path() to specify the path.
20094 * The output of this function, tTaken together with the output of
20095 * g_settings_list_schemas() represents the complete list of all
20096 * installed schemas.
20097 * #GSettings schemas that are available. The list must not be
20098 * modified or freed.
20100 * Returns: (element-type utf8) (transfer none): a list of relocatable
20106 * G_VARIANT_TYPE_UINT32:
20108 * The type of an integer value that can range from 0 to 4294967295.
20109 * That's one number for everyone who was around in the late 1970s.
20115 * @short_description: Mount management
20116 * @include: gio/gio.h
20117 * @see_also: GVolume, GUnixMount
20119 * The #GMount interface represents user-visible mounts. Note, when
20120 * porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume.
20121 * #GMount is a "mounted" filesystem that you can access. Mounted is in
20122 * quotes because it's not the same as a unix mount, it might be a gvfs
20123 * mount, but you can still access the files on it if you use GIO. Might or
20124 * might not be related to a volume object.
20125 * Unmounting a #GMount instance is an asynchronous operation. For
20126 * more information about asynchronous operations, see #GAsyncReady
20127 * and #GSimpleAsyncReady. To unmount a #GMount instance, first call
20128 * g_mount_unmount_with_operation() with (at least) the #GMount instance and a
20129 * #GAsyncReadyCallback. The callback will be fired when the
20130 * operation has resolved (either with success or failure), and a
20131 * #GAsyncReady structure will be passed to the callback. That
20132 * callback should then call g_mount_unmount_with_operation_finish() with the #GMount
20133 * and the #GAsyncReady data to see if the operation was completed
20134 * successfully. If an @error is present when g_mount_unmount_with_operation_finish()
20135 * is called, then it will be filled with any error information.
20140 * g_drive_eject_with_operation:
20141 * @drive: a #GDrive.
20142 * @flags: flags affecting the unmount if required for eject
20143 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
20144 * @cancellable: optional #GCancellable object, %NULL to ignore.
20145 * @callback: a #GAsyncReadyCallback, or %NULL.
20146 * @user_data: user data passed to @callback.
20148 * Ejects a drive. This is an asynchronous operation, and is
20149 * finished by calling g_drive_eject_with_operation_finish() with the @drive
20150 * and #GAsyncResult data returned in the @callback.
20158 * @struct_type: the type of the elements to allocate
20159 * @mem: the currently allocated memory
20160 * @n_structs: the number of elements to allocate
20162 * Reallocates the memory pointed to by @mem, so that it now has space for
20163 * the memory, which may have been moved.
20164 * Care is taken to avoid overflow when calculating the size of the allocated block.
20166 * Returns: a pointer to the new allocated memory, cast to a pointer to @struct_type
20171 * g_mount_can_unmount:
20172 * @mount: a #GMount.
20174 * Checks if @mount can be mounted.
20176 * Returns: %TRUE if the @mount can be unmounted.
20181 * GParamSpecValueArray:
20182 * @parent_instance: private #GParamSpec portion
20183 * @element_spec: a #GParamSpec describing the elements contained in arrays of this property, may be %NULL
20184 * @fixed_n_elements: if greater than 0, arrays of this property will always have this many elements
20186 * A #GParamSpec derived structure that contains the meta data for #GValueArray properties.
20192 * @src: A pointer to the data which should be copied
20193 * @data: Additional data
20195 * A function of this signature is used to copy the node data
20196 * when doing a deep-copy of a tree.
20198 * Returns: A pointer to the copy
20204 * g_dbus_connection_register_object:
20205 * @connection: A #GDBusConnection.
20206 * @object_path: The object path to register at.
20207 * @interface_info: Introspection data for the interface.
20208 * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
20209 * @user_data: Data to pass to functions in @vtable.
20210 * @user_data_free_func: Function to call when the object path is unregistered.
20211 * @error: Return location for error or %NULL.
20213 * Registers callbacks for exported objects at @object_path with the
20214 * D-Bus interface that is described in @interface_info.
20215 * Calls to functions in @vtable (and @user_data_free_func) will
20216 * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
20217 * loop</link> of the thread you are calling this method from.
20218 * Note that all #GVariant values passed to functions in @vtable will match
20219 * the signature given in @interface_info - if a remote caller passes
20220 * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
20221 * is returned to the remote caller.
20222 * Additionally, if the remote caller attempts to invoke methods or
20223 * access properties not mentioned in @interface_info the
20224 * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
20225 * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
20226 * are returned to the caller.
20227 * It is considered a programming error if the
20228 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
20229 * #GVariant of incorrect type.
20230 * If an existing callback is already registered at @object_path and
20231 * GDBus automatically implements the standard D-Bus interfaces
20232 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
20233 * and org.freedesktop.Peer, so you don't have to implement those for
20234 * the objects you export. You <emphasis>can</emphasis> implement
20235 * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
20236 * and setting of properties asynchronously.
20237 * Note that the reference count on @interface_info will be
20238 * incremented by 1 (unless allocated statically, e.g. if the
20239 * reference count is -1, see g_dbus_interface_info_ref()) for as long
20240 * as the object is exported. Also note that @vtable will be copied.
20241 * See <xref linkend="gdbus-server"/> for an example of how to use this method.
20242 * that can be used with g_dbus_connection_unregister_object() .
20244 * Returns: 0 if @error is set, otherwise a registration id (never 0)
20250 * GAskPasswordFlags:
20251 * @G_ASK_PASSWORD_NEED_PASSWORD: operation requires a password.
20252 * @G_ASK_PASSWORD_NEED_USERNAME: operation requires a username.
20253 * @G_ASK_PASSWORD_NEED_DOMAIN: operation requires a domain.
20254 * @G_ASK_PASSWORD_SAVING_SUPPORTED: operation supports saving settings.
20255 * @G_ASK_PASSWORD_ANONYMOUS_SUPPORTED: operation supports anonymous users.
20257 * #GAskPasswordFlags are used to request specific information from the
20258 * user, or to notify the user of their choices in an authentication
20265 * @icon: #gconstpointer to an icon object.
20267 * Gets a hash for an icon.
20268 * use in a #GHashTable or similar data structure.
20271 * Returns: a #guint containing a hash for the @icon, suitable for
20276 * g_application_command_line_get_exit_status:
20277 * @cmdline: a #GApplicationCommandLine
20279 * Gets the exit status of @cmdline. See
20280 * g_application_command_line_set_exit_status() for more information.
20282 * Returns: the exit status
20288 * g_socket_get_listen_backlog:
20289 * @socket: a #GSocket.
20291 * Gets the listen backlog setting of the socket. For details on this,
20292 * see g_socket_set_listen_backlog().
20294 * Returns: the maximum number of pending connections.
20300 * g_async_initable_new_valist_async:
20301 * @object_type: a #GType supporting #GAsyncInitable.
20302 * @first_property_name: the name of the first property, followed by the value, and other property value pairs, and ended by %NULL.
20303 * @var_args: The var args list generated from @first_property_name.
20304 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the operation.
20305 * @cancellable: optional #GCancellable object, %NULL to ignore.
20306 * @callback: a #GAsyncReadyCallback to call when the initialization is finished
20307 * @user_data: the data to pass to callback function
20309 * Helper function for constructing #GAsyncInitiable object. This is
20310 * similar to g_object_new_valist() but also initializes the object
20312 * When the initialization is finished, @callback will be called. You can
20313 * then call g_async_initable_new_finish() to get the new object and check
20321 * g_network_service_get_protocol:
20322 * @srv: a #GNetworkService
20324 * Gets @srv's protocol name (eg, "tcp").
20326 * Returns: @srv's protocol name
20332 * g_unix_fd_message_new:
20334 * Creates a new #GUnixFDMessage containing an empty file descriptor
20337 * Returns: a new #GUnixFDMessage
20345 * Opaque class for definining and scheduling IO jobs.
20350 * G_VARIANT_TYPE_DOUBLE:
20352 * The type of a double precision IEEE754 floating point number.
20353 * These guys go up to about 1.80e308 (plus and minus) but miss out on
20354 * some numbers in between. In any case, that's far greater than the
20355 * estimated number of fundamental particles in the observable
20361 * GTypeInterfaceCheckFunc:
20362 * @check_data: data passed to g_type_add_interface_check().
20363 * @g_iface: the interface that has been initialized
20365 * A callback called after an interface vtable is initialized.
20366 * See g_type_add_interface_check().
20375 * The fundamental type from which all flags types are derived.
20380 * g_settings_get_child:
20381 * @settings: a #GSettings object
20382 * @name: the name of the 'child' schema
20383 * @returns: (transfer full): a 'child' settings object
20385 * Creates a 'child' settings object which has a base path of
20386 * <replaceable>base-path</replaceable>/@name", where
20387 * <replaceable>base-path</replaceable> is the base path of @settings.
20388 * The schema for the child settings object must have been declared
20389 * in the schema of @settings using a <tag class="starttag">child</tag> element.
20397 * @g_type_class: the parent class
20398 * @mask: a mask covering all possible values.
20399 * @n_values: the number of possible values.
20400 * @values: an array of #GFlagsValue structs describing the individual values.
20402 * The class of a flags type holds information about its
20408 * g_simple_action_group_new:
20410 * Creates a new, empty, #GSimpleActionGroup.
20412 * Returns: a new #GSimpleActionGroup
20418 * g_resolver_lookup_by_address_async:
20419 * @resolver: a #GResolver
20420 * @address: the address to reverse-resolve
20421 * @cancellable: (allow-none): a #GCancellable, or %NULL
20422 * @callback: (scope async): callback to call after resolution completes
20423 * @user_data: (closure): data for @callback
20425 * Begins asynchronously reverse-resolving @address to determine its
20426 * associated hostname, and eventually calls @callback, which must
20427 * call g_resolver_lookup_by_address_finish() to get the final result.
20434 * g_dbus_method_info_ref:
20435 * @info: A #GDBusMethodInfo
20437 * If @info is statically allocated does nothing. Otherwise increases
20438 * the reference count.
20440 * Returns: The same @info.
20446 * G_TYPE_DBUS_SIGNAL_INFO:
20448 * The #GType for a boxed type holding a #GDBusSignalInfo.
20455 * g_dbus_connection_signal_subscribe:
20456 * @connection: A #GDBusConnection.
20457 * @sender: Sender name to match on (unique or well-known name) or %NULL to listen from all senders.
20458 * @interface_name: D-Bus interface name to match on or %NULL to match on all interfaces.
20459 * @member: D-Bus signal name to match on or %NULL to match on all signals.
20460 * @object_path: Object path to match on or %NULL to match on all object paths.
20461 * @arg0: Contents of first string argument to match on or %NULL to match on all kinds of arguments.
20462 * @flags: Flags describing how to subscribe to the signal (currently unused).
20463 * @callback: Callback to invoke when there is a signal matching the requested data.
20464 * @user_data: User data to pass to @callback.
20465 * @user_data_free_func: Function to free @user_data with when subscription is removed or %NULL.
20467 * Subscribes to signals on @connection and invokes @callback with a
20468 * whenever the signal is received. Note that @callback
20469 * will be invoked in the <link
20470 * linkend="g-main-context-push-thread-default">thread-default main
20471 * loop</link> of the thread you are calling this method from.
20472 * If @connection is not a message bus connection, @sender must be
20474 * If @sender is a well-known name note that @callback is invoked with
20475 * the unique name for the owner of @sender, not the well-known name
20476 * as one would expect. This is because the message bus rewrites the
20477 * name. As such, to avoid certain race conditions, users should be
20478 * tracking the name owner of the well-known name and use that when
20479 * processing the received signal.
20481 * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
20487 * g_themed_icon_append_name:
20488 * @icon: a #GThemedIcon
20489 * @iconname: name of icon to append to list of icons from within @icon.
20491 * Append a name to the list of icons from within @icon.
20493 * Note that doing so invalidates the hash computed by prior calls
20494 * to g_icon_hash().
20500 * g_socket_listener_add_socket:
20501 * @listener: a #GSocketListener
20502 * @socket: a listening #GSocket
20503 * @source_object: (allow-none): Optional #GObject identifying this source
20504 * @error: #GError for error reporting, or %NULL to ignore.
20506 * Adds @socket to the set of sockets that we try to accept
20507 * new clients from. The socket must be bound to a local
20508 * address and listened to.
20509 * to accept to identify this particular source, which is
20510 * useful if you're listening on multiple addresses and do
20511 * different things depending on what address is connected to.
20513 * Returns: %TRUE on success, %FALSE on error.
20519 * g_file_info_set_is_hidden:
20520 * @info: a #GFileInfo.
20521 * @is_hidden: a #gboolean.
20523 * Sets the "is_hidden" attribute in a #GFileInfo according to @is_symlink.
20524 * See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN.
20530 * @is_running: set to %TRUE to indicate that the loop is running. This is not very important since calling g_main_run() will set this to %TRUE anyway.
20532 * Creates a new #GMainLoop for th default main context.
20534 * Returns: a new #GMainLoop
20535 * Deprecated: 2.2: Use g_main_loop_new() instead
20540 * G_VARIANT_TYPE_VARIANT:
20542 * The type of a box that contains any other value (including another
20548 * GUnixSocketAddress:abstract:
20550 * Whether or not this is an abstract address
20551 * distinguishes between zero-padded and non-zero-padded
20552 * abstract addresses.
20554 * Deprecated: Use #GUnixSocketAddress:address-type, which
20561 * Evaluates to a time span of one day.
20568 * g_io_extension_get_type:
20569 * @extension: a #GIOExtension
20571 * Gets the type associated with @extension.
20573 * Returns: the type of @extension
20580 * A handle to an object implementing the #GFileIface interface.
20581 * Generally stores a location within the file system. Handles do not
20582 * necessarily represent files or directories that currently exist.
20587 * G_TYPE_CHECK_INSTANCE:
20588 * @instance: Location of a #GTypeInstance structure.
20590 * Checks if @instance is a valid #GTypeInstance structure,
20591 * otherwise issues a warning and returns %FALSE.
20592 * This macro should only be used in type implementations.
20594 * Returns: %TRUE on success.
20599 * g_data_output_stream_put_int32:
20600 * @stream: a #GDataOutputStream.
20601 * @data: a #gint32.
20602 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
20603 * @error: a #GError, %NULL to ignore.
20605 * Puts a signed 32-bit integer into the output stream.
20607 * Returns: %TRUE if @data was successfully added to the @stream.
20612 * GConverterInputStream:
20614 * An implementation of #GFilterInputStream that allows data
20620 * GTestLogFatalFunc:
20621 * @log_domain: the log domain of the message
20622 * @log_level: the log level of the message (including the fatal and recursion flags)
20623 * @message: the message to process
20624 * @user_data: user data, set in g_test_log_set_fatal_handler()
20626 * Specifies the prototype of fatal log handler functions.
20628 * Returns: %TRUE if the program should abort, %FALSE otherwise
20634 * g_buffered_input_stream_new_sized:
20635 * @base_stream: a #GInputStream
20638 * Creates a new #GBufferedInputStream from the given @base_stream,
20639 * with a buffer set to @size.
20641 * Returns: a #GInputStream.
20646 * g_socket_is_closed:
20647 * @socket: a #GSocket
20649 * Checks whether a socket is closed.
20651 * Returns: %TRUE if socket is closed, %FALSE otherwise
20657 * g_filter_output_stream_get_close_base_stream:
20658 * @stream: a #GFilterOutputStream.
20660 * Returns whether the base stream will be closed when @stream is
20663 * Returns: %TRUE if the base stream will be closed.
20668 * GDBusMessageClass:
20670 * Class structure for #GDBusMessage.
20678 * @prepare: Called before all the file descriptors are polled. If the source can determine that it is ready here (without waiting for the results of the poll() call) it should return %TRUE. It can also return a @timeout_ value which should be the maximum timeout (in milliseconds) which should be passed to the poll() call. The actual timeout used will be -1 if all sources returned -1, or it will be the minimum of all the
20679 * @check: Called after all the file descriptors are polled. The source should return %TRUE if it is ready to be dispatched. Note that some time may have passed since the previous prepare function was called, so the source should be checked again here.
20680 * @dispatch: Called to dispatch the event source, after it has returned %TRUE in either its @prepare or its @check function. The @dispatch function is passed in a callback function and data. The callback function may be %NULL if the source was never connected to a callback using g_source_set_callback(). The @dispatch function should call the callback function with @user_data and whatever additional parameters are needed for this type of event source.
20681 * @finalize: Called when the source is finalized.
20683 * The <structname>GSourceFuncs</structname> struct contains a table of
20684 * functions used to handle event sources in a generic manner.
20685 * For idle sources, the prepare and check functions always return %TRUE
20686 * to indicate that the source is always ready to be processed. The prepare
20687 * function also returns a timeout value of 0 to ensure that the poll() call
20688 * doesn't block (since that would be time wasted which could have been spent
20689 * running the idle function).
20690 * For timeout sources, the prepare and check functions both return %TRUE
20691 * if the timeout interval has expired. The prepare function also returns
20692 * a timeout value to ensure that the poll() call doesn't block too long
20693 * and miss the next timeout.
20694 * For file descriptor sources, the prepare function typically returns %FALSE,
20695 * since it must wait until poll() has been called before it knows whether
20696 * any events need to be processed. It sets the returned timeout to -1 to
20697 * indicate that it doesn't mind how long the poll() call blocks. In the
20698 * check function, it tests the results of the poll() call to see if the
20699 * required condition has been met, and returns %TRUE if so.
20704 * g_dbus_auth_observer_new:
20706 * Creates a new #GDBusAuthObserver object.
20708 * Returns: A #GDBusAuthObserver. Free with g_object_unref().
20714 * g_file_info_copy_into:
20715 * @src_info: source to copy attributes from.
20716 * @dest_info: destination to copy attributes to.
20718 * Copies all of the #GFileAttribute<!-- -->s from @src_info to @dest_info.
20723 * GFileAttributeMatcher:
20725 * Determines if a string matches a file attribute.
20732 * Error domain for GIO. Errors in this domain will be from the #GIOErrorEnum enumeration.
20733 * See #GError for more information on error domains.
20738 * GVolumeMonitor::drive-connected:
20739 * @volume_monitor: The volume monitor emitting the signal.
20740 * @drive: a #GDrive that was connected.
20742 * Emitted when a drive is connected to the system.
20747 * g_settings_bind_with_mapping:
20748 * @settings: a #GSettings object
20749 * @key: the key to bind
20750 * @object: (type GObject.Object): a #GObject
20751 * @property: the name of the property to bind
20752 * @flags: flags for the binding
20753 * @get_mapping: a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mapping
20754 * @set_mapping: a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mapping
20755 * @user_data: data that gets passed to @get_mapping and @set_mapping
20756 * @destroy: #GDestroyNotify function for @user_data
20758 * Create a binding between the @key in the @settings object
20759 * and the property @property of @object.
20760 * The binding uses the provided mapping functions to map between
20761 * settings and property values.
20762 * Note that the lifecycle of the binding is tied to the object,
20763 * and that you can have only one binding per object property.
20764 * If you bind the same property twice on the same object, the second
20765 * binding overrides the first one.
20772 * g_socket_client_get_socket_type:
20773 * @client: a #GSocketClient.
20775 * Gets the socket type of the socket client.
20776 * See g_socket_client_set_socket_type() for details.
20778 * Returns: a #GSocketFamily
20785 * @short_description: File and Directory Handling
20786 * @include: gio/gio.h
20787 * @see_also: #GFileInfo, #GFileEnumerator
20789 * #GFile is a high level abstraction for manipulating files on a
20790 * virtual file system. #GFile<!-- -->s are lightweight, immutable
20791 * objects that do no I/O upon creation. It is necessary to understand that
20792 * #GFile objects do not represent files, merely an identifier for a file. All
20793 * file content I/O is implemented as streaming operations (see #GInputStream and
20795 * g_file_new_for_path() if you have a path.
20796 * g_file_new_for_uri() if you have a URI.
20797 * g_file_new_for_commandline_arg() for a command line argument.
20798 * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name().
20799 * One way to think of a #GFile is as an abstraction of a pathname. For normal
20800 * files the system pathname is what is stored internally, but as #GFile<!-- -->s
20801 * are extensible it could also be something else that corresponds to a pathname
20802 * in a userspace implementation of a filesystem.
20803 * #GFile<!-- -->s make up hierarchies of directories and files that correspond to the
20804 * files on a filesystem. You can move through the file system with #GFile using
20805 * g_file_get_parent() to get an identifier for the parent directory, g_file_get_child()
20806 * to get a child within a directory, g_file_resolve_relative_path() to resolve a relative
20807 * path between two #GFile<!-- -->s. There can be multiple hierarchies, so you may not
20808 * end up at the same root if you repeatedly call g_file_get_parent() on two different
20810 * All #GFile<!-- -->s have a basename (get with g_file_get_basename()). These names
20811 * are byte strings that are used to identify the file on the filesystem (relative to
20812 * its parent directory) and there is no guarantees that they have any particular charset
20813 * encoding or even make any sense at all. If you want to use filenames in a user
20814 * interface you should use the display name that you can get by requesting the
20815 * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
20816 * This is guaranteed to be in utf8 and can be used in a user interface. But always
20817 * store the real basename or the #GFile to use to actually access the file, because
20818 * there is no way to go from a display name to the actual name.
20819 * Using #GFile as an identifier has the same weaknesses as using a path in that
20820 * there may be multiple aliases for the same file. For instance, hard or
20821 * soft links may cause two different #GFile<!-- -->s to refer to the same file.
20822 * and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if
20823 * two #GFile<!-- -->s point to the same file you can query for the
20824 * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
20825 * canonicalization of pathnames passed in, so that trivial differences in the
20826 * path string used at creation (duplicated slashes, slash at end of path, "."
20827 * or ".." path segments, etc) does not create different #GFile<!-- -->s.
20828 * Many #GFile operations have both synchronous and asynchronous versions
20829 * to suit your application. Asynchronous versions of synchronous functions
20830 * simply have _async() appended to their function names. The asynchronous
20831 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
20832 * the operation, producing a GAsyncResult which is then passed to the
20833 * function's matching _finish() operation.
20834 * Some #GFile operations do not have synchronous analogs, as they may
20835 * take a very long time to finish, and blocking may leave an application
20836 * unusable. Notable cases include:
20837 * g_file_mount_mountable() to mount a mountable file.
20838 * g_file_unmount_mountable_with_operation() to unmount a mountable file.
20839 * g_file_eject_mountable_with_operation() to eject a mountable file.
20840 * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
20841 * One notable feature of #GFile<!-- -->s are entity tags, or "etags" for
20842 * short. Entity tags are somewhat like a more abstract version of the
20843 * traditional mtime, and can be used to quickly determine if the file has
20844 * been modified from the version on the file system. See the HTTP 1.1
20845 * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
20846 * for HTTP Etag headers, which are a very similar concept.
20849 * To construct a #gfile, you can use:
20850 * Other possible causes for aliases are: case insensitive filesystems, short
20855 * GBufferedOutputStream:
20857 * An implementation of #GFilterOutputStream with a sized buffer.
20862 * G_FILE_ATTRIBUTE_STANDARD_COPY_NAME:
20864 * A key in the "standard" namespace for getting the copy name of the file.
20865 * The copy name is an optional version of the name. If available it's always
20866 * in UTF8, and corresponds directly to the original filename (only transcoded to
20867 * UTF8). This is useful if you want to copy the file to another filesystem that
20868 * might have a different encoding. If the filename is not a valid string in the
20869 * encoding selected for the filesystem it is in then the copy name will not be set.
20870 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
20875 * g_desktop_app_info_get_filename:
20876 * @info: a #GDesktopAppInfo
20878 * When @info was created from a known filename, return it. In some
20879 * situations such as the #GDesktopAppInfo returned from
20880 * g_desktop_app_info_new_from_keyfile(), this function will return %NULL.
20882 * Returns: The full path to the file for @info, or %NULL if not known.
20888 * g_settings_backend_path_writable_changed:
20889 * @backend: a #GSettingsBackend implementation
20890 * @path: the name of the path
20892 * Signals that the writability of all keys below a given path may have
20894 * Since GSettings performs no locking operations for itself, this call
20895 * will always be made in response to external events.
20902 * GActionGroup::action-removed:
20903 * @action_group: the #GActionGroup that changed
20904 * @action_name: the name of the action in @action_group
20906 * Signals that an action is just about to be removed from the group.
20907 * This signal is emitted before the action is removed, so the action
20908 * is still visible and can be queried from the signal handler.
20917 * Gets an icon for a #GFile. Implements #GLoadableIcon.
20922 * g_socket_set_timeout:
20923 * @socket: a #GSocket.
20924 * @timeout: the timeout for @socket, in seconds, or 0 for none
20926 * Sets the time in seconds after which I/O operations on @socket will
20927 * time out if they have not yet completed.
20928 * On a blocking socket, this means that any blocking #GSocket
20929 * operation will time out after @timeout seconds of inactivity,
20930 * returning %G_IO_ERROR_TIMED_OUT.
20931 * On a non-blocking socket, calls to g_socket_condition_wait() will
20932 * also fail with %G_IO_ERROR_TIMED_OUT after the given time. Sources
20933 * created with g_socket_create_source() will trigger after
20934 * set, at which point calling g_socket_receive(), g_socket_send(),
20935 * g_socket_check_connect_result(), etc, will fail with
20936 * %G_IO_ERROR_TIMED_OUT.
20937 * If @timeout is 0 (the default), operations will never time out
20939 * Note that if an I/O operation is interrupted by a signal, this may
20940 * cause the timeout to be reset.
20947 * g_app_info_set_as_default_for_extension:
20948 * @appinfo: a #GAppInfo.
20949 * @extension: a string containing the file extension (without the dot).
20950 * @error: a #GError.
20952 * Sets the application as the default handler for the given file extension.
20954 * Returns: %TRUE on success, %FALSE on error.
20959 * G_CLOSURE_NEEDS_MARSHAL:
20960 * @closure: a #GClosure
20962 * Check if the closure still needs a marshaller. See g_closure_set_marshal().
20964 * Returns: %TRUE if a #GClosureMarshal marshaller has not yet been set on
20969 * g_unix_connection_send_fd:
20970 * @connection: a #GUnixConnection
20971 * @fd: a file descriptor
20972 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
20973 * @error: (allow-none): #GError for error reporting, or %NULL to ignore.
20975 * Passes a file descriptor to the recieving side of the
20976 * connection. The recieving end has to call g_unix_connection_receive_fd()
20977 * to accept the file descriptor.
20978 * As well as sending the fd this also writes a single byte to the
20979 * stream, as this is required for fd passing to work on some
20982 * Returns: a %TRUE on success, %NULL on error.
20988 * G_FILE_ATTRIBUTE_TRASH_DELETION_DATE:
20990 * A key in the "trash" namespace. When requested against
20991 * items in "trash:///", will return the date and time when the file
20992 * was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss.
20993 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
21002 * Interface that handles proxy connection and payload.
21009 * g_content_type_is_unknown:
21010 * @type: a content type string
21012 * Checks if the content type is the generic "unknown" type.
21013 * On UNIX this is the "application/octet-stream" mimetype,
21014 * while on win32 it is "*".
21016 * Returns: %TRUE if the type is the unknown type.
21021 * GMountMountFlags:
21022 * @G_MOUNT_MOUNT_NONE: No flags set.
21024 * Flags used when mounting a mount.
21029 * GZlibCompressor:file-info:
21031 * If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is
21032 * %G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name
21033 * and modification time from the file info to the the GZIP header.
21040 * g_async_result_get_source_object:
21041 * @res: a #GAsyncResult
21043 * Gets the source object from a #GAsyncResult.
21044 * or %NULL if there is none.
21046 * Returns: (transfer full): a new reference to the source object for the @res,
21051 * g_file_replace_async:
21052 * @file: input #GFile.
21053 * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the current #GFile, or NULL to ignore.
21054 * @make_backup: %TRUE if a backup should be created.
21055 * @flags: a set of #GFileCreateFlags.
21056 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
21057 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
21058 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
21059 * @user_data: (closure): the data to pass to callback function
21061 * Asynchronously overwrites the file, replacing the contents, possibly
21062 * creating a backup copy of the file first.
21063 * For more details, see g_file_replace() which is
21064 * the synchronous version of this call.
21065 * When the operation is finished, @callback will be called. You can then call
21066 * g_file_replace_finish() to get the result of the operation.
21071 * g_file_set_display_name_finish:
21072 * @file: input #GFile.
21073 * @res: a #GAsyncResult.
21074 * @error: a #GError, or %NULL
21076 * Finishes setting a display name started with
21077 * g_file_set_display_name_async().
21078 * Free the returned object with g_object_unref().
21080 * Returns: (transfer full): a #GFile or %NULL on error.
21085 * GBusNameLostCallback:
21086 * @connection: The #GDBusConnection on which to acquire the name or %NULL if the connection was disconnected.
21087 * @name: The name being owned.
21088 * @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().
21090 * Invoked when the name is lost or @connection has been closed.
21097 * g_unix_mount_point_get_mount_path:
21098 * @mount_point: a #GUnixMountPoint.
21100 * Gets the mount path for a unix mount point.
21102 * Returns: a string containing the mount path.
21107 * g_mount_get_uuid:
21108 * @mount: a #GMount.
21110 * Gets the UUID for the @mount. The reference is typically based on
21111 * the file system UUID for the mount in question and should be
21112 * considered an opaque string. Returns %NULL if there is no UUID
21114 * The returned string should be freed with g_free()
21115 * when no longer needed.
21117 * Returns: the UUID for @mount or %NULL if no UUID can be computed.
21122 * g_settings_revert:
21123 * @settings: a #GSettings instance
21125 * Reverts all non-applied changes to the settings. This function
21126 * does nothing unless @settings is in 'delay-apply' mode; see
21127 * g_settings_delay(). In the normal case settings are always applied
21129 * Change notifications will be emitted for affected keys.
21134 * GBusNameOwnerFlags:
21135 * @G_BUS_NAME_OWNER_FLAGS_NONE: No flags set.
21136 * @G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT: Allow another message bus connection to claim the the name.
21137 * @G_BUS_NAME_OWNER_FLAGS_REPLACE: If another message bus connection owns the name and have specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection.
21139 * Flags used in g_bus_own_name().
21146 * G_IS_PARAM_SPEC_ULONG:
21147 * @pspec: a valid #GParamSpec instance
21149 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG.
21151 * Returns: %TRUE on success.
21156 * g_file_resolve_relative_path:
21157 * @file: input #GFile.
21158 * @relative_path: a given relative path string.
21160 * Resolves a relative path for @file to an absolute path.
21161 * This call does no blocking i/o.
21162 * is %NULL or if @file is invalid.
21163 * Free the returned object with g_object_unref().
21165 * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path
21170 * g_application_get_flags:
21171 * @application: a #GApplication
21172 * @returns: the flags for @application
21174 * Gets the flags for @application.
21175 * See #GApplicationFlags.
21182 * G_VARIANT_TYPE_ANY:
21184 * An indefinite type that is a supertype of every type (including
21190 * GPollableSourceFunc:
21191 * @pollable_stream: the #GPollableInputStream or #GPollableOutputStream
21192 * @user_data: data passed in by the user.
21194 * This is the function type of the callback used for the #GSource
21195 * returned by g_pollable_input_stream_create_source() and
21196 * g_pollable_output_stream_create_source().
21198 * Returns: it should return %FALSE if the source should be removed.
21204 * g_file_info_set_display_name:
21205 * @info: a #GFileInfo.
21206 * @display_name: a string containing a display name.
21208 * Sets the display name for the current #GFileInfo.
21209 * See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME.
21214 * SECTION:gloadableico:
21215 * @short_description: Loadable Icons
21216 * @include: gio/gio.h
21217 * @see_also: #GIcon, #GThemedIcon
21219 * Extends the #GIcon interface and adds the ability to
21220 * load icons from streams.
21227 * <structname>GDateTime</structname> is an opaque structure whose members
21228 * cannot be accessed directly.
21236 * @file: input #GFile.
21237 * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the current #GFile, or #NULL to ignore.
21238 * @make_backup: %TRUE if a backup should be created.
21239 * @flags: a set of #GFileCreateFlags.
21240 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
21241 * @error: a #GError, or %NULL
21243 * Returns an output stream for overwriting the file, possibly
21244 * creating a backup copy of the file first. If the file doesn't exist,
21245 * it will be created.
21246 * This will try to replace the file in the safest way possible so
21247 * that any errors during the writing will not affect an already
21248 * existing copy of the file. For instance, for local files it
21249 * may write to a temporary file and then atomically rename over
21250 * the destination when the stream is closed.
21251 * By default files created are generally readable by everyone,
21252 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
21253 * will be made readable only to the current user, to the level that
21254 * is supported on the target filesystem.
21255 * If @cancellable is not %NULL, then the operation can be cancelled by
21256 * triggering the cancellable object from another thread. If the operation
21257 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
21258 * If you pass in a non-#NULL @etag value, then this value is
21259 * compared to the current entity tag of the file, and if they differ
21260 * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
21261 * that the file has been changed since you last read it. You can get
21262 * the new etag from g_file_output_stream_get_etag() after you've
21263 * finished writing and closed the #GFileOutputStream. When you load
21264 * a new file you can use g_file_input_stream_query_info() to get
21265 * the etag of the file.
21266 * If @make_backup is %TRUE, this function will attempt to make a backup
21267 * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
21268 * error will be returned. If you want to replace anyway, try again with
21269 * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
21270 * and if the file is some other form of non-regular file then a
21271 * G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
21272 * Some file systems don't allow all file names, and may
21273 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
21274 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
21275 * Other errors are possible too, and depend on what kind of
21276 * filesystem the file is on.
21277 * Free the returned object with g_object_unref().
21279 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
21284 * G_FILE_ATTRIBUTE_OWNER_USER:
21286 * A key in the "owner" namespace for getting the user name of the
21287 * file's owner. Corresponding #GFileAttributeType is
21288 * %G_FILE_ATTRIBUTE_TYPE_STRING.
21293 * g_dbus_message_copy:
21294 * @message: A #GDBusMessage.
21295 * @error: Return location for error or %NULL.
21297 * Copies @message. The copy is a deep copy and the returned
21298 * #GDBusMessage is completely identical except that it is guaranteed
21299 * to not be locked.
21300 * This operation can fail if e.g. @message contains file descriptors
21301 * and the per-process or system-wide open files limit is reached.
21302 * g_object_unref().
21304 * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set. Free with
21311 * @size: number of bytes to allocate.
21313 * Allocates @size bytes on the stack; these bytes will be freed when the current
21314 * stack frame is cleaned up. This macro essentially just wraps the alloca()
21315 * function present on most UNIX variants.
21316 * Thus it provides the same advantages and pitfalls as alloca():
21318 * <varlistentry><term></term><listitem><para>
21319 * + alloca() is very fast, as on most systems it's implemented by just adjusting
21320 * the stack pointer register.
21321 * </para></listitem></varlistentry>
21322 * <varlistentry><term></term><listitem><para>
21323 * + It doesn't cause any memory fragmentation, within its scope, separate alloca()
21324 * blocks just build up and are released together at function end.
21325 * </para></listitem></varlistentry>
21326 * <varlistentry><term></term><listitem><para>
21327 * - Allocation sizes have to fit into the current stack frame. For instance in a
21328 * threaded environment on Linux, the per-thread stack size is limited to 2 Megabytes,
21329 * so be sparse with alloca() uses.
21330 * </para></listitem></varlistentry>
21331 * <varlistentry><term></term><listitem><para>
21332 * - Allocation failure due to insufficient stack space is not indicated with a %NULL
21333 * return like e.g. with malloc(). Instead, most systems probably handle it the same
21334 * way as out of stack space situations from infinite function recursion, i.e.
21335 * with a segmentation fault.
21336 * </para></listitem></varlistentry>
21337 * <varlistentry><term></term><listitem><para>
21338 * - Special care has to be taken when mixing alloca() with GNU C variable sized arrays.
21339 * Stack space allocated with alloca() in the same scope as a variable sized array
21340 * will be freed together with the variable sized array upon exit of that scope, and
21341 * not upon exit of the enclosing function scope.
21342 * </para></listitem></varlistentry>
21345 * Returns: space for @size bytes, allocated on the stack
21350 * G_DEFINE_TYPE_WITH_CODE:
21351 * @TN: The name of the new type, in Camel case.
21352 * @t_n: The name of the new type in lowercase, with words separated by '_'.
21353 * @T_P: The #GType of the parent type.
21354 * @_C_: Custom code that gets inserted in the *_get_type() function.
21356 * A convenience macro for type implementations.
21357 * Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the
21358 * *_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().
21359 * See G_DEFINE_TYPE_EXTENDED() for an example.
21366 * G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET:
21368 * A key in the "standard" namespace for getting the symlink target, if the file
21369 * is a symlink. Corresponding #GFileAttributeType is
21370 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
21375 * g_dbus_connection_new_for_address_sync:
21376 * @address: A D-Bus address.
21377 * @flags: Flags describing how to make the connection.
21378 * @observer: A #GDBusAuthObserver or %NULL.
21379 * @cancellable: A #GCancellable or %NULL.
21380 * @error: Return location for error or %NULL.
21382 * Synchronously connects and sets up a D-Bus client connection for
21383 * exchanging D-Bus messages with an endpoint specified by @address
21384 * which must be in the D-Bus address format.
21385 * This constructor can only be used to initiate client-side
21386 * connections - use g_dbus_connection_new_sync() if you need to act
21387 * as the server. In particular, @flags cannot contain the
21388 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
21389 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
21390 * This is a synchronous failable constructor. See
21391 * g_dbus_connection_new_for_address() for the asynchronous version.
21392 * If @observer is not %NULL it may be used to control the
21393 * authentication process.
21395 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
21401 * g_resolver_free_addresses: (skip)
21402 * @addresses: a #GList of #GInetAddress
21404 * Frees @addresses (which should be the return value from
21405 * g_resolver_lookup_by_name() or g_resolver_lookup_by_name_finish()).
21406 * (This is a convenience method; you can also simply free the results
21414 * GMountOperation:anonymous:
21416 * Whether to use an anonymous user when authenticating.
21421 * g_socket_condition_check:
21422 * @socket: a #GSocket
21423 * @condition: a #GIOCondition mask to check
21425 * Checks on the readiness of @socket to perform operations.
21426 * The operations specified in @condition are checked for and masked
21427 * against the currently-satisfied conditions on @socket. The result
21429 * Note that on Windows, it is possible for an operation to return
21430 * %G_IO_ERROR_WOULD_BLOCK even immediately after
21431 * g_socket_condition_check() has claimed that the socket is ready for
21432 * writing. Rather than calling g_socket_condition_check() and then
21433 * writing to the socket if it succeeds, it is generally better to
21434 * simply try writing to the socket right away, and try again later if
21435 * the initial attempt returns %G_IO_ERROR_WOULD_BLOCK.
21436 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition;
21437 * these conditions will always be set in the output if they are true.
21438 * This call never blocks.
21440 * Returns: the @GIOCondition mask of the current state
21446 * g_bus_unown_name:
21447 * @owner_id: An identifier obtained from g_bus_own_name()
21449 * Stops owning a name.
21456 * g_dbus_proxy_get_interface_info:
21457 * @proxy: A #GDBusProxy
21459 * Returns the #GDBusInterfaceInfo, if any, specifying the minimal
21460 * interface that @proxy conforms to.
21461 * See the #GDBusProxy:g-interface-info property for more details.
21462 * object, it is owned by @proxy.
21464 * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
21470 * g_proxy_address_get_destination_hostnam:
21471 * @proxy: a #GProxyAddress
21473 * Gets @proxy's destination hostname.
21475 * Returns: the @proxy's destination hostname
21481 * g_dbus_method_invocation_get_connection:
21482 * @invocation: A #GDBusMethodInvocation.
21484 * Gets the #GDBusConnection the method was invoked on.
21486 * Returns: (transfer none): A #GDBusConnection. Do not free, it is owned by @invocation.
21492 * g_srv_target_get_hostname:
21493 * @target: a #GSrvTarget
21495 * Gets @target's hostname (in ASCII form; if you are going to present
21496 * this to the user, you should use g_hostname_is_ascii_encoded() to
21497 * check if it contains encoded Unicode segments, and use
21498 * g_hostname_to_unicode() to convert it if it does.)
21500 * Returns: @target's hostname
21506 * g_io_extension_point_get_extensions:
21507 * @extension_point: a #GIOExtensionPoint
21509 * Gets a list of all extensions that implement this extension point.
21510 * The list is sorted by priority, beginning with the highest priority.
21511 * #GIOExtension<!-- -->s. The list is owned by GIO and should not be
21514 * Returns: (element-type GIOExtension) (transfer none): a #GList of
21519 * GSettings:has-unapplied:
21521 * If this property is %TRUE, the #GSettings object has outstanding
21522 * changes that will be applied when g_settings_apply() is called.
21527 * g_dbus_proxy_set_interface_info:
21528 * @proxy: A #GDBusProxy
21529 * @info: Minimum interface this proxy conforms to or %NULL to unset.
21531 * Ensure that interactions with @proxy conform to the given
21532 * interface. For example, when completing a method call, if the type
21533 * signature of the message isn't what's expected, the given #GError
21534 * is set. Signals that have a type signature mismatch are simply
21536 * See the #GDBusProxy:g-interface-info property for more details.
21544 * @parent: the #GNode to place the new #GNode under
21545 * @node: the #GNode to insert
21547 * Inserts a #GNode as the last child of the given parent.
21549 * Returns: the inserted #GNode
21554 * g_memory_input_stream_add_data:
21555 * @stream: a #GMemoryInputStream
21556 * @data: (array length=len) (element-type guint8): input data
21557 * @len: length of the data, may be -1 if @data is a nul-terminated string
21558 * @destroy: (allow-none): function that is called to free @data, or %NULL
21560 * Appends @data to data that can be read from the input stream
21565 * g_content_type_get_description:
21566 * @type: a content type string
21568 * Gets the human readable description of the content type.
21569 * returned string with g_free()
21571 * Returns: a short description of the content type @type. Free the
21576 * G_PARAM_SPEC_INT64:
21577 * @pspec: a valid #GParamSpec instance
21579 * Cast a #GParamSpec instance into a #GParamSpecInt64.
21584 * g_permission_release_finish:
21585 * @permission: a #GPermission instance
21586 * @result: the #GAsyncResult given to the #GAsyncReadyCallback
21587 * @error: a pointer to a %NULL #GError, or %NULL
21588 * @returns: %TRUE if the permission was successfully released
21590 * Collects the result of attempting to release the permission
21591 * represented by @permission.
21592 * This is the second half of the asynchronous version of
21593 * g_permission_release().
21600 * G_TYPE_RESERVED_BSE_LAST:
21602 * Last fundamental type number reserved for BSE.
21607 * g_dbus_message_get_num_unix_fds:
21608 * @message: A #GDBusMessage.
21610 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
21612 * Returns: The value.
21618 * GDBusSubtreeFlags:
21619 * @G_DBUS_SUBTREE_FLAGS_NONE: No flags set.
21620 * @G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES: 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.
21622 * Flags passed to g_dbus_connection_register_subtree().
21629 * g_dbus_connection_unregister_object:
21630 * @connection: A #GDBusConnection.
21631 * @registration_id: A registration id obtained from g_dbus_connection_register_object().
21633 * Unregisters an object.
21635 * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
21641 * G_FILE_ATTRIBUTE_STANDARD_TARGET_URI:
21643 * A key in the "standard" namespace for getting the target URI for the file, in
21644 * the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files.
21645 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
21650 * SECTION:gmemoryoutputstrea:
21651 * @short_description: Streaming output operations on memory chunks
21652 * @include: gio/gio.h
21653 * @see_also: #GMemoryInputStream
21655 * #GMemoryOutputStream is a class for using arbitrary
21656 * memory chunks as output for GIO streaming output operations.
21661 * g_tls_client_connection_new:
21662 * @base_io_stream: the #GIOStream to wrap
21663 * @server_identity: (allow-none): the expected identity of the server
21664 * @error: #GError for error reporting, or %NULL to ignore.
21666 * Creates a new #GTlsClientConnection wrapping @base_io_stream (which
21667 * must have pollable input and output streams) which is assumed to
21668 * communicate with the server identified by @server_identity.
21670 * Returns: the new #GTlsClientConnection, or %NULL on error
21676 * g_network_address_get_scheme:
21677 * @addr: a #GNetworkAddress
21679 * Gets @addr's scheme
21681 * Returns: @addr's scheme (%NULL if not built from URI)
21687 * G_FILE_ATTRIBUTE_TIME_ACCESS:
21689 * A key in the "time" namespace for getting the time the file was last
21690 * accessed. Corresponding #GFileAttributeType is
21691 * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
21692 * file was last accessed.
21697 * g_unix_mount_guess_icon:
21698 * @mount_entry: a #GUnixMountEntry
21700 * Guesses the icon of a Unix mount.
21702 * Returns: (transfer full): a #GIcon
21708 * @drive: a #GDrive.
21710 * Emitted when the drive's state has changed.
21715 * g_file_info_unset_attribute_mask:
21716 * @info: #GFileInfo.
21718 * Unsets a mask set by g_file_info_set_attribute_mask(), if one
21724 * GAction:parameter-type:
21726 * The type of the parameter that must be given when activating the
21735 * @file: input #GFile
21736 * @flags: a set of #GFileMonitorFlags
21737 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
21738 * @error: a #GError, or %NULL
21740 * Obtains a file or directory monitor for the given file, depending
21741 * on the type of the file.
21742 * If @cancellable is not %NULL, then the operation can be cancelled by
21743 * triggering the cancellable object from another thread. If the operation
21744 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
21745 * Free the returned object with g_object_unref().
21747 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
21753 * GTlsConnection:peer-certificate-errors:
21755 * The errors noticed-and-ignored while verifying
21756 * #GTlsConnection:peer-certificate. Normally this should be %0, but
21757 * it may not be if #GTlsClientConnection::validation-flags is not
21758 * %G_TLS_CERTIFICATE_VALIDATE_ALL, or if
21759 * #GTlsConnection::accept-certificate overrode the default
21767 * g_credentials_set_unix_user:
21768 * @credentials: A #GCredentials.
21769 * @uid: The UNIX user identifier to set.
21770 * @error: Return location for error or %NULL.
21772 * Tries to set the UNIX user identifier on @credentials. This method
21773 * is only available on UNIX platforms.
21774 * This operation can fail if #GCredentials is not supported on the
21775 * OS or if the native credentials type does not contain information
21776 * about the UNIX user.
21778 * Returns: %TRUE if @uid was set, %FALSE if error is set.
21785 * @in_marshal: Indicates whether the closure is currently being invoked with g_closure_invoke()
21786 * @is_invalid: Indicates whether the closure has been invalidated by g_closure_invalidate()
21788 * A #GClosure represents a callback supplied by the programmer.
21793 * SECTION:gsocketaddres:
21794 * @short_description: Abstract base class representing endpoints for socket communication
21796 * #GSocketAddress is the equivalent of <type>struct sockaddr</type>
21797 * in the BSD sockets API. This is an abstract class; use
21798 * #GInetSocketAddress for internet sockets, or #GUnixSocketAddress
21799 * for UNIX domain sockets.
21804 * G_TIME_SPAN_MINUTE:
21806 * Evaluates to a time span of one minute.
21813 * g_drive_can_start_degraded:
21814 * @drive: a #GDrive.
21816 * Checks if a drive can be started degraded.
21818 * Returns: %TRUE if the @drive can be started degraded, %FALSE otherwise.
21824 * g_content_type_can_be_executable:
21825 * @type: a content type string
21827 * Checks if a content type can be executable. Note that for instance
21828 * things like text files can be executables (i.e. scripts and batch files).
21829 * can be executable, %FALSE otherwise.
21831 * Returns: %TRUE if the file type corresponds to a type that
21836 * GSimpleActionClass:
21837 * @activate: the class closure for the activate signal
21846 * G_TYPE_INSTANCE_GET_INTERFACE:
21847 * @instance: Location of the #GTypeInstance structure.
21848 * @g_type: The #GType of the interface to be returned.
21849 * @c_type: The C type of the interface structure.
21851 * Get the interface structure for interface @g_type of a given @instance.
21852 * This macro should only be used in type implementations.
21854 * Returns: a pointer to the interface structure
21859 * g_file_info_get_attribute_as_string:
21860 * @info: a #GFileInfo.
21861 * @attribute: a file attribute key.
21863 * Gets the value of a attribute, formated as a string.
21864 * This escapes things as needed to make the string valid
21866 * When you're done with the string it must be freed with g_free().
21868 * Returns: a UTF-8 string associated with the given @attribute.
21873 * GResolver::reload:
21874 * @resolver: a #GResolver
21876 * Emitted when the resolver notices that the system resolver
21877 * configuration has changed.
21882 * g_settings_get_range:
21883 * @settings: a #GSettings
21884 * @key: the key to query the range of
21885 * @returns: a #GVariant describing the range
21887 * Queries the range of a key.
21888 * This function will return a #GVariant that fully describes the range
21889 * of values that are valid for @key.
21890 * The type of #GVariant returned is <literal>(sv)</literal>. The
21891 * string describes the type of range restriction in effect. The type
21892 * and meaning of the value contained in the variant depends on the
21894 * If the string is <literal>'type'</literal> then the variant contains
21895 * an empty array. The element type of that empty array is the expected
21896 * type of value and all values of that type are valid.
21897 * If the string is <literal>'enum'</literal> then the variant contains
21898 * an array enumerating the possible values. Each item in the array is
21899 * a possible valid value and no other values are valid.
21900 * If the string is <literal>'flags'</literal> then the variant contains
21901 * an array. Each item in the array is a value that may appear zero or
21902 * one times in an array to be used as the value for this key. For
21903 * example, if the variant contained the array <literal>['x',
21904 * 'y']</literal> then the valid values for the key would be
21905 * <literal>[]</literal>, <literal>['x']</literal>,
21906 * <literal>['y']</literal>, <literal>['x', 'y']</literal> and
21907 * <literal>['y', 'x']</literal>.
21908 * Finally, if the string is <literal>'range'</literal> then the variant
21909 * contains a pair of like-typed values -- the minimum and maximum
21910 * permissible values for this key.
21911 * This information should not be used by normal programs. It is
21912 * considered to be a hint for introspection purposes. Normal programs
21913 * should already know what is permitted by their own schema. The
21914 * format may change in any way in the future -- but particularly, new
21915 * forms may be added to the possibilities described above.
21916 * It is a programmer error to give a @key that isn't contained in the
21917 * schema for @settings.
21918 * You should free the returned value with g_variant_unref() when it is
21919 * no longer needed.
21926 * g_socket_client_set_protocol:
21927 * @client: a #GSocketClient.
21928 * @protocol: a #GSocketProtocol
21930 * Sets the protocol of the socket client.
21931 * The sockets created by this object will use of the specified
21933 * If @protocol is %0 that means to use the default
21934 * protocol for the socket family and type.
21941 * G_TYPE_IO_CONDITION:
21943 * The #GType for #GIOCondition.
21949 * @mount: a #GMount.
21950 * @flags: flags affecting the operation
21951 * @cancellable: optional #GCancellable object, %NULL to ignore.
21952 * @callback: a #GAsyncReadyCallback, or %NULL.
21953 * @user_data: user data passed to @callback.
21955 * Unmounts a mount. This is an asynchronous operation, and is
21956 * finished by calling g_mount_unmount_finish() with the @mount
21957 * and #GAsyncResult data returned in the @callback.
21959 * Deprecated: 2.22: Use g_mount_unmount_with_operation() instead.
21964 * g_io_module_load:
21965 * @module: a #GIOModule.
21967 * Required API for GIO modules to implement.
21968 * This function is ran after the module has been loaded into GIO,
21969 * to initialize the module.
21974 * g_unix_mount_point_is_user_mountable:
21975 * @mount_point: a #GUnixMountPoint.
21977 * Checks if a unix mount point is mountable by the user.
21979 * Returns: %TRUE if the mount point is user mountable.
21984 * g_app_info_supports_uris:
21985 * @appinfo: a #GAppInfo.
21987 * Checks if the application supports reading files and directories from URIs.
21989 * Returns: %TRUE if the @appinfo supports URIs.
21994 * g_seekable_can_truncate:
21995 * @seekable: a #GSeekable.
21997 * Tests if the stream can be truncated.
21999 * Returns: %TRUE if the stream can be truncated, %FALSE otherwise.
22004 * G_URI_RESERVED_CHARS_ALLOWED_IN_PATH:
22006 * Allowed characters in a path. Includes "!$&'()*+,;=:@/".
22011 * GDesktopAppInfoLookup:
22013 * Interface that is used by backends to associate default
22014 * handlers with URI schemes.
22019 * GTlsClientConnection:use-ssl3:
22021 * If %TRUE, tells the connection to use SSL 3.0 rather than trying
22022 * to negotiate the best version of TLS or SSL to use. This can be
22023 * used when talking to servers that don't implement version
22024 * negotiation correctly and therefore refuse to handshake at all with
22025 * a "modern" TLS handshake.
22032 * G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE:
22034 * A key in the "unix" namespace for getting the block size for the file
22035 * system. This attribute is only available for UNIX file systems.
22036 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
22041 * g_dbus_interface_info_lookup_property:
22042 * @info: A #GDBusInterfaceInfo.
22043 * @name: A D-Bus property name (typically in CamelCase).
22045 * Looks up information about a property.
22046 * This cost of this function is O(n) in number of properties.
22048 * Returns: A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info.
22054 * G_TYPE_PARAM_UINT64:
22056 * The #GType of #GParamSpecUInt64.
22061 * GBusNameAcquiredCallback:
22062 * @connection: The #GDBusConnection on which to acquired the name.
22063 * @name: The name being owned.
22064 * @user_data: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().
22066 * Invoked when the name is acquired.
22073 * GMountOperationResult:
22074 * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the user specified data is now available
22075 * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation to be aborted
22076 * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not implemented)
22078 * #GMountOperationResult is returned as a result when a request for
22079 * information is send by the mounting operation.
22084 * g_mount_can_eject:
22085 * @mount: a #GMount.
22087 * Checks if @mount can be eject.
22089 * Returns: %TRUE if the @mount can be ejected.
22094 * SECTION:gmountoperatio:
22095 * @short_description: Object used for authentication and user interaction
22096 * @include: gio/gio.h
22098 * #GMountOperation provides a mechanism for interacting with the user.
22099 * It can be used for authenticating mountable operations, such as loop
22100 * mounting files, hard drive partitions or server locations. It can
22101 * also be used to ask the user questions or show a list of applications
22102 * preventing unmount or eject operations from completing.
22103 * Note that #GMountOperation is used for more than just #GMount
22104 * objects – for example it is also used in g_drive_start() and
22106 * Users should instantiate a subclass of this that implements all the
22107 * various callbacks to show the required dialogs, such as
22108 * #GtkMountOperation. If no user interaction is desired (for example
22109 * when automounting filesystems at login time), usually %NULL can be
22110 * passed, see each method taking a #GMountOperation for details.
22115 * g_data_input_stream_read_int64:
22116 * @stream: a given #GDataInputStream.
22117 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
22118 * @error: #GError for error reporting.
22120 * Reads a 64-bit/8-byte value from @stream.
22121 * In order to get the correct byte order for this read operation,
22122 * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
22123 * If @cancellable is not %NULL, then the operation can be cancelled by
22124 * triggering the cancellable object from another thread. If the operation
22125 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
22126 * an error occurred.
22128 * Returns: a signed 64-bit/8-byte value read from @stream or %0 if
22133 * SECTION:gunixoutputstrea:
22134 * @short_description: Streaming output operations for UNIX file descriptors
22135 * @include: gio/gunixoutputstream.h
22136 * @see_also: #GOutputStream
22138 * #GUnixOutputStream implements #GOutputStream for writing to a
22139 * UNIX file descriptor, including asynchronous operations. The file
22140 * descriptor must be selectable, so it doesn't work with opened files.
22141 * Note that <filename><gio/gunixoutputstream.h></filename> belongs
22142 * to the UNIX-specific GIO interfaces, thus you have to use the
22143 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
22148 * g_simple_async_result_get_op_res_gpointer: (skip)
22149 * @simple: a #GSimpleAsyncResult.
22151 * Gets a pointer result as returned by the asynchronous function.
22153 * Returns: a pointer from the result.
22158 * g_memory_output_stream_steal_data:
22159 * @ostream: a #GMemoryOutputStream
22161 * Gets any loaded data from the @ostream. Ownership of the data
22162 * is transferred to the caller; when no longer needed it must be
22163 * freed using the free function set in @ostream's
22164 * #GMemoryOutputStream:destroy-function property.
22166 * Returns: (transfer full): the stream's data
22172 * G_PARAM_SPEC_VARIANT:
22173 * @pspec: a #GParamSpec
22175 * Casts a #GParamSpec into a #GParamSpecVariant.
22184 * @short_description: An action
22186 * #GAction represents a single named action.
22187 * The main interface to an action is that it can be activated with
22188 * g_action_activate(). This results in the 'activate' signal being
22189 * emitted. An activation has a #GVariant parameter (which may be
22190 * %NULL). The correct type for the parameter is determined by a static
22191 * parameter type (which is given at construction time).
22192 * An action may optionally have a state, in which case the state may be
22193 * set with g_action_set_state(). This call takes a #GVariant. The
22194 * correct type for the state is determined by a static state type
22195 * (which is given at construction time).
22196 * The state may have a hint associated with it, specifying its valid
22198 * #GAction is merely the interface to the concept of an action, as
22199 * described above. Various implementations of actions exist, including
22200 * #GSimpleAction and #GtkAction.
22201 * In all cases, the implementing class is responsible for storing the
22202 * name of the action, the parameter type, the enabled state, the
22203 * optional state type and the state and emitting the appropriate
22204 * signals when these change. The implementor responsible for filtering
22205 * calls to g_action_activate() and g_action_set_state() for type safety
22206 * and for the state being enabled.
22207 * Probably the only useful thing to do with a #GAction is to put it
22208 * inside of a #GSimpleActionGroup.
22213 * GTlsConnection:use-system-certdb:
22215 * Whether or not the system certificate database will be used to
22216 * verify peer certificates. See
22217 * g_tls_connection_set_use_system_certdb().
22224 * g_data_input_stream_read_uint32:
22225 * @stream: a given #GDataInputStream.
22226 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
22227 * @error: #GError for error reporting.
22229 * Reads an unsigned 32-bit/4-byte value from @stream.
22230 * In order to get the correct byte order for this read operation,
22231 * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
22232 * If @cancellable is not %NULL, then the operation can be cancelled by
22233 * triggering the cancellable object from another thread. If the operation
22234 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
22235 * an error occurred.
22237 * Returns: an unsigned 32-bit/4-byte value read from the @stream or %0 if
22242 * GInetAddress:is-any:
22244 * Whether this is the "any" address for its family.
22245 * See g_inet_address_get_is_any().
22252 * g_volume_get_uuid:
22253 * @volume: a #GVolume.
22255 * Gets the UUID for the @volume. The reference is typically based on
22256 * the file system UUID for the volume in question and should be
22257 * considered an opaque string. Returns %NULL if there is no UUID
22259 * The returned string should be freed with g_free()
22260 * when no longer needed.
22262 * Returns: the UUID for @volume or %NULL if no UUID can be computed.
22267 * GDataStream:byte-order:
22269 * The ::byte-order property determines the byte ordering that
22270 * is used when reading multi-byte entities (such as integers)
22276 * g_resolver_error_quark:
22278 * Gets the #GResolver Error Quark.
22280 * Returns: a #GQuark.
22286 * g_input_stream_clear_pending:
22287 * @stream: input stream
22289 * Clears the pending flag on @stream.
22294 * g_file_copy_finish:
22295 * @file: input #GFile.
22296 * @res: a #GAsyncResult.
22297 * @error: a #GError, or %NULL
22299 * Finishes copying the file started with
22300 * g_file_copy_async().
22302 * Returns: a %TRUE on success, %FALSE on error.
22307 * G_TYPE_CHECK_INSTANCE_CAST:
22308 * @instance: Location of a #GTypeInstance structure.
22309 * @g_type: The type to be returned.
22310 * @c_type: The corresponding C type of @g_type.
22312 * Checks that @instance is an instance of the type identified by @g_type
22313 * and issues a warning if this is not the case. Returns @instance casted
22314 * to a pointer to @c_type.
22315 * This macro should only be used in type implementations.
22320 * G_IS_PARAM_SPEC_PARAM:
22321 * @pspec: a valid #GParamSpec instance
22323 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM.
22325 * Returns: %TRUE on success.
22330 * g_file_get_uri_scheme:
22331 * @file: input #GFile.
22333 * Gets the URI scheme for a #GFile.
22334 * RFC 3986 decodes the scheme as:
22336 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
22337 * </programlisting>
22338 * Common schemes include "file", "http", "ftp", etc.
22339 * This call does no blocking i/o.
22340 * #GFile. The returned string should be freed with g_free()
22341 * when no longer needed.
22343 * Returns: a string containing the URI scheme for the given
22350 * Interface for asynchronously initializable objects.
22357 * g_settings_set_boolean:
22358 * @settings: a #GSettings object
22359 * @key: the name of the key to set
22360 * @value: the value to set it to
22361 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
22363 * Sets @key in @settings to @value.
22364 * A convenience variant of g_settings_set() for booleans.
22365 * It is a programmer error to give a @key that isn't specified as
22366 * having a boolean type in the schema for @settings.
22373 * SECTION:gsocketclien:
22374 * @short_description: Helper for connecting to a network service
22375 * @include: gio/gio.h
22376 * @see_also: #GSocketConnection, #GSocketListener
22378 * #GSocketClient is a high-level utility class for connecting to a
22379 * network host using a connection oriented socket type.
22380 * You create a #GSocketClient object, set any options you want, then
22381 * call a sync or async connect operation, which returns a #GSocketConnection
22382 * subclass on success.
22383 * The type of the #GSocketConnection object returned depends on the type of
22384 * the underlying socket that is in use. For instance, for a TCP/IP connection
22385 * it will be a #GTcpConnection.
22392 * G_TYPE_FUNDAMENTAL_SHIFT:
22394 * Shift value used in converting numbers to type IDs.
22399 * g_app_info_get_all:
22401 * Gets a list of all of the applications currently registered
22403 * For desktop files, this includes applications that have
22404 * <literal>NoDisplay=true</literal> set or are excluded from
22405 * display by means of <literal>OnlyShowIn</literal> or
22406 * <literal>NotShowIn</literal>. See g_app_info_should_show().
22407 * The returned list does not include applications which have
22408 * the <literal>Hidden</literal> key set.
22410 * Returns: (element-type GAppInfo) (transfer full): a newly allocated #GList of references to #GAppInfo<!---->s.
22416 * @socket: a #GSocket
22417 * @buffer: (array length=size): the buffer containing the data to send.
22418 * @size: the number of bytes to send
22419 * @cancellable: (allow-none): a %GCancellable or %NULL
22420 * @error: #GError for error reporting, or %NULL to ignore.
22422 * Tries to send @size bytes from @buffer on the socket. This is
22423 * mainly used by connection-oriented sockets; it is identical to
22424 * g_socket_send_to() with @address set to %NULL.
22425 * If the socket is in blocking mode the call will block until there is
22426 * space for the data in the socket queue. If there is no space available
22427 * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
22428 * will be returned. To be notified when space is available, wait for the
22429 * %G_IO_OUT condition. Note though that you may still receive
22430 * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
22431 * notified of a %G_IO_OUT condition. (On Windows in particular, this is
22432 * very common due to the way the underlying APIs work.)
22433 * On error -1 is returned and @error is set accordingly.
22436 * Returns: Number of bytes written (which may be less than @size), or -1
22442 * g_socket_client_set_timeout:
22443 * @client: a #GSocketClient.
22444 * @timeout: the timeout
22446 * Sets the I/O timeout for sockets created by @client. @timeout is a
22447 * time in seconds, or 0 for no timeout (the default).
22448 * The timeout value affects the initial connection attempt as well,
22449 * so setting this may cause calls to g_socket_client_connect(), etc,
22450 * to fail with %G_IO_ERROR_TIMED_OUT.
22458 * @struct_type: the type of the elements to allocate.
22459 * @n_structs: the number of elements to allocate.
22461 * Allocates @n_structs elements of type @struct_type, initialized to 0's.
22462 * The returned pointer is cast to a pointer to the given type.
22463 * If @n_structs is 0 it returns %NULL.
22464 * Care is taken to avoid overflow when calculating the size of the allocated block.
22465 * Since the returned pointer is already casted to the right type,
22466 * it is normally unnecessary to cast it explicitly, and doing
22467 * so might hide memory allocation errors.
22469 * Returns: a pointer to the allocated memory, cast to a pointer to @struct_type.
22474 * g_file_open_readwrite_finish:
22475 * @file: input #GFile.
22476 * @res: a #GAsyncResult.
22477 * @error: a #GError, or %NULL
22479 * Finishes an asynchronous file read operation started with
22480 * g_file_open_readwrite_async().
22481 * Free the returned object with g_object_unref().
22483 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
22489 * GMountOperation:choice:
22491 * The index of the user's choice when a question is asked during the
22492 * mount operation. See the #GMountOperation::ask-question signal.
22497 * g_buffered_output_stream_get_auto_grow:
22498 * @stream: a #GBufferedOutputStream.
22500 * Checks if the buffer automatically grows as data is added.
22501 * %FALSE otherwise.
22503 * Returns: %TRUE if the @stream's buffer automatically grows,
22509 * @family: the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.
22510 * @type: the socket type to use.
22511 * @protocol: the id of the protocol to use, or 0 for default.
22512 * @error: #GError for error reporting, or %NULL to ignore.
22514 * Creates a new #GSocket with the defined family, type and protocol.
22515 * If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
22516 * for the family and type is used.
22517 * The @protocol is a family and type specific int that specifies what
22518 * kind of protocol to use. #GSocketProtocol lists several common ones.
22519 * Many families only support one protocol, and use 0 for this, others
22520 * support several and using 0 means to use the default protocol for
22521 * the family and type.
22522 * The protocol id is passed directly to the operating
22523 * system, so you can use protocols not listed in #GSocketProtocol if you
22524 * know the protocol number used for it.
22525 * Free the returned object with g_object_unref().
22527 * Returns: a #GSocket or %NULL on error.
22533 * g_converter_input_stream_get_converter:
22534 * @converter_stream: a #GConverterInputStream
22536 * Gets the #GConverter that is used by @converter_stream.
22538 * Returns: (transfer none): the converter of the converter input stream
22544 * g_file_info_set_attribute_stringv:
22545 * @info: a #GFileInfo.
22546 * @attribute: a file attribute key.
22547 * @attr_value: a %NULL terminated string array
22549 * Sets the @attribute to contain the given @attr_value,
22557 * g_themed_icon_get_names:
22558 * @icon: a #GThemedIcon.
22560 * Gets the names of icons from within @icon.
22562 * Returns: (transfer none): a list of icon names.
22567 * g_file_mount_mountable:
22568 * @file: input #GFile.
22569 * @flags: flags affecting the operation
22570 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
22571 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
22572 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
22573 * @user_data: (closure): the data to pass to callback function
22575 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
22576 * Using @mount_operation, you can request callbacks when, for instance,
22577 * passwords are needed during authentication.
22578 * If @cancellable is not %NULL, then the operation can be cancelled by
22579 * triggering the cancellable object from another thread. If the operation
22580 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
22581 * When the operation is finished, @callback will be called. You can then call
22582 * g_file_mount_mountable_finish() to get the result of the operation.
22589 * The #GCredentials structure contains only private data and
22590 * should only be accessed using the provided API.
22597 * g_desktop_app_info_lookup_get_default_for_uri_scheme:
22598 * @lookup: a #GDesktopAppInfoLookup
22599 * @uri_scheme: a string containing a URI scheme.
22601 * Gets the default application for launching applications
22602 * using this URI scheme for a particular GDesktopAppInfoLookup
22604 * The GDesktopAppInfoLookup interface and this function is used
22605 * to implement g_app_info_get_default_for_uri_scheme() backends
22606 * in a GIO module. There is no reason for applications to use it
22607 * directly. Applications should use g_app_info_get_default_for_uri_scheme().
22609 * Returns: (transfer full): #GAppInfo for given @uri_scheme or %NULL on error.
22610 * Deprecated: The #GDesktopAppInfoLookup interface is deprecated and unused by gio.
22617 * The fundamental type from which all #GParamSpec types are derived.
22624 * The <structname>GTypePlugin</structname> typedef is used as a placeholder
22625 * for objects that implement the <structname>GTypePlugin</structname>
22631 * G_FILE_ATTRIBUTE_STANDARD_ICON:
22633 * A key in the "standard" namespace for getting the icon for the file.
22634 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT.
22635 * The value for this key should contain a #GIcon.
22640 * g_application_get_inactivity_timeout:
22641 * @application: a #GApplication
22643 * Gets the current inactivity timeout for the application.
22644 * This is the amount of time (in milliseconds) after the last call to
22645 * g_application_release() before the application stops running.
22647 * Returns: the timeout, in milliseconds
22653 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL:
22655 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled.
22656 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
22663 * g_unix_mount_get_mount_path:
22664 * @mount_entry: input #GUnixMountEntry to get the mount path for.
22666 * Gets the mount path for a unix mount.
22668 * Returns: the mount path for @mount_entry.
22673 * g_app_info_get_all_for_type:
22674 * @content_type: the content type to find a #GAppInfo for
22676 * Gets a list of all #GAppInfos for a given content type.
22677 * for given @content_type or %NULL on error.
22679 * Returns: (element-type GAppInfo) (transfer full): #GList of #GAppInfos
22684 * g_win32_input_stream_get_handle:
22685 * @stream: a #GWin32InputStream
22687 * Return the Windows file handle that the stream reads from.
22689 * Returns: The file handle of @stream
22695 * G_TYPE_PARAM_BOOLEAN:
22697 * The #GType of #GParamSpecBoolean.
22702 * GDataOutputStream:byte-order:
22704 * Determines the byte ordering that is used when writing
22705 * multi-byte entities (such as integers) to the stream.
22710 * g_dbus_method_invocation_get_method_info:
22711 * @invocation: A #GDBusMethodInvocation.
22713 * Gets information about the method call, if any.
22715 * Returns: A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation.
22721 * g_tls_certificate_list_new_from_file:
22722 * @file: file containing PEM-encoded certificates to import
22723 * @error: #GError for error reporting, or %NULL to ignore.
22725 * Creates one or more #GTlsCertificate<!-- -->s from the PEM-encoded
22726 * data in @file. If @file cannot be read or parsed, the function will
22727 * return %NULL and set @error. If @file does not contain any
22728 * PEM-encoded certificates, this will return an empty list and not
22730 * #GList containing #GTlsCertificate objects. You must free the list
22731 * and its contents when you are done with it.
22733 * Returns: (element-type Gio.TlsCertificate) (transfer full): a
22739 * g_inet_address_new_from_bytes:
22740 * @bytes: raw address data
22741 * @family: the address family of @bytes
22743 * Creates a new #GInetAddress from the given @family and @bytes.
22744 * %G_INET_ADDRESS_IPV6.
22746 * Returns: a new #GInetAddress corresponding to @family and @bytes.
22752 * g_io_stream_splice_finish:
22753 * @result: a #GAsyncResult.
22754 * @error: a #GError location to store the error occuring, or %NULL to ignore.
22756 * Finishes an asynchronous io stream splice operation.
22758 * Returns: %TRUE on success, %FALSE otherwise.
22764 * g_file_attribute_info_list_unref:
22765 * @list: The #GFileAttributeInfoList to unreference.
22767 * Removes a reference from the given @list. If the reference count
22768 * falls to zero, the @list is deleted.
22773 * G_VALUE_HOLDS_OBJECT:
22774 * @value: a valid #GValue structure
22776 * Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT.
22778 * Returns: %TRUE on success.
22784 * @type: the #GType value of the type.
22785 * @type_name: the name of the type.
22786 * @class_size: the size of the class structure.
22787 * @instance_size: the size of the instance structure.
22789 * A structure holding information for a specific type. It is
22790 * filled in by the g_type_query() function.
22797 * TLS (Transport Layer Security, aka SSL) backend. This is an
22798 * internal type used to coordinate the different classes implemented
22799 * by a TLS backend.
22806 * g_bus_own_name_on_connection:
22807 * @connection: A #GDBusConnection.
22808 * @name: The well-known name to own.
22809 * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
22810 * @name_acquired_handler: Handler to invoke when @name is acquired or %NULL.
22811 * @name_lost_handler: Handler to invoke when @name is lost or %NULL.
22812 * @user_data: User data to pass to handlers.
22813 * @user_data_free_func: Function for freeing @user_data or %NULL.
22815 * Like g_bus_own_name() but takes a #GDBusConnection instead of a
22817 * g_bus_unown_name() to stop owning the name.
22819 * Returns: An identifier (never 0) that an be used with
22825 * g_unix_input_stream_set_close_fd:
22826 * @stream: a #GUnixInputStream
22827 * @close_fd: %TRUE to close the file descriptor when done
22829 * Sets whether the file descriptor of @stream shall be closed
22830 * when the stream is closed.
22837 * GMountOperation::ask-password:
22838 * @op: a #GMountOperation requesting a password.
22839 * @message: string containing a message to display to the user.
22840 * @default_user: string containing the default user name.
22841 * @default_domain: string containing the default domain.
22842 * @flags: a set of #GAskPasswordFlags.
22844 * Emitted when a mount operation asks the user for a password.
22845 * If the message contains a line break, the first line should be
22846 * presented as a heading. For example, it may be used as the
22847 * primary text in a #GtkMessageDialog.
22854 * The fundamental type corresponding to nul-terminated C strings.
22859 * g_file_query_filesystem_info:
22860 * @file: input #GFile.
22861 * @attributes: an attribute query string.
22862 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
22863 * @error: a #GError.
22865 * Similar to g_file_query_info(), but obtains information
22866 * about the filesystem the @file is on, rather than the file itself.
22867 * For instance the amount of space available and the type of
22869 * The @attributes value is a string that specifies the file attributes that
22870 * should be gathered. It is not an error if it's not possible to read a particular
22871 * requested attribute from a file - it just won't be set. @attributes should
22872 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
22873 * means all attributes, and a wildcard like "fs:*" means all attributes in the fs
22874 * namespace. The standard namespace for filesystem attributes is "fs".
22875 * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
22876 * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
22877 * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
22878 * If @cancellable is not %NULL, then the operation can be cancelled by
22879 * triggering the cancellable object from another thread. If the operation
22880 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
22881 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
22882 * Other errors are possible too, and depend on what kind of filesystem the file is on.
22883 * Free the returned object with g_object_unref().
22885 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
22890 * g_socket_control_message_serialize:
22891 * @message: a #GSocketControlMessage
22892 * @data: A buffer to write data to
22894 * Converts the data in the message to bytes placed in the
22896 * returned by g_socket_control_message_get_size() on this
22904 * g_dbus_connection_get_unique_name:
22905 * @connection: A #GDBusConnection.
22907 * Gets the unique name of @connection as assigned by the message
22908 * bus. This can also be used to figure out if @connection is a
22909 * message bus connection.
22910 * bus connection. Do not free this string, it is owned by
22912 * Returns: The unique name or %NULL if @connection is not a message
22918 * g_unix_input_stream_new:
22919 * @fd: a UNIX file descriptor
22920 * @close_fd: %TRUE to close the file descriptor when done
22922 * Creates a new #GUnixInputStream for the given @fd.
22923 * If @close_fd is %TRUE, the file descriptor will be closed
22924 * when the stream is closed.
22926 * Returns: a new #GUnixInputStream
22931 * g_simple_async_result_run_in_thread: (skip)
22932 * @simple: a #GSimpleAsyncResult.
22933 * @func: a #GSimpleAsyncThreadFunc.
22934 * @io_priority: the io priority of the request.
22935 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
22937 * Runs the asynchronous job in a separate thread and then calls
22938 * g_simple_async_result_complete_in_idle() on @simple to return
22939 * the result to the appropriate main loop.
22940 * Calling this function takes a reference to @simple for as long as
22941 * is needed to run the job and report its completion.
22946 * g_dbus_proxy_get_cached_property:
22947 * @proxy: A #GDBusProxy.
22948 * @property_name: Property name.
22950 * Looks up the value for a property from the cache. This call does no
22952 * If @proxy has an expected interface (see
22953 * #GDBusProxy:g-interface-info), then @property_name (for existence)
22954 * is checked against it.
22955 * for @property_name or %NULL if the value is not in the cache. The
22956 * returned reference must be freed with g_variant_unref().
22958 * Returns: A reference to the #GVariant instance that holds the value
22964 * g_file_io_stream_query_info:
22965 * @stream: a #GFileIOStream.
22966 * @attributes: a file attribute query string.
22967 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
22968 * @error: a #GError, %NULL to ignore.
22970 * Queries a file io stream for the given @attributes.
22971 * This function blocks while querying the stream. For the asynchronous
22972 * version of this function, see g_file_io_stream_query_info_async().
22973 * While the stream is blocked, the stream will set the pending flag
22974 * internally, and any other operations on the stream will fail with
22975 * %G_IO_ERROR_PENDING.
22976 * Can fail if the stream was already closed (with @error being set to
22977 * %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
22978 * set to %G_IO_ERROR_PENDING), or if querying info is not supported for
22979 * the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). I
22980 * all cases of failure, %NULL will be returned.
22981 * If @cancellable is not %NULL, then the operation can be cancelled by
22982 * triggering the cancellable object from another thread. If the operation
22983 * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
22986 * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
22992 * G_PARAM_SPEC_OBJECT:
22993 * @pspec: a valid #GParamSpec instance
22995 * Casts a #GParamSpec instance into a #GParamSpecObject.
23000 * GSocketAddressEnumerator:
23002 * Enumerator type for objects that contain or generate
23003 * #GSocketAddress<!-- -->es.
23008 * g_mount_operation_get_usernam:
23009 * @op: a #GMountOperation.
23011 * Get the user name from the mount operation.
23013 * Returns: a string containing the user name.
23019 * @parent_instance: private #GParamSpec portion
23020 * @minimum: minimum value for the property specified
23021 * @maximum: maximum value for the property specified
23022 * @default_value: default value for the property specified
23024 * A #GParamSpec derived structure that contains the meta data for 64bit integer properties.
23029 * SECTION:gproxyaddres:
23030 * @short_description: An internet address with proxy information
23032 * Support for proxied #GInetSocketAddress.
23037 * GDBusMessageFlags:
23038 * @G_DBUS_MESSAGE_FLAGS_NONE: No flags set.
23039 * @G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED: A reply is not expected.
23040 * @G_DBUS_MESSAGE_FLAGS_NO_AUTO_START: The bus must not launch an owner for the destination name in response to this message.
23042 * Message flags used in #GDBusMessage.
23049 * G_PROXY_RESOLVER_EXTENSION_POINT_NAME:
23051 * Extension point for proxy resolving functionality.
23052 * See <link linkend="extending-gio">Extending GIO</link>.
23057 * G_VALUE_HOLDS_FLAGS:
23058 * @value: a valid #GValue structure
23060 * Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS.
23062 * Returns: %TRUE on success.
23067 * GClassFinalizeFunc:
23068 * @g_class: The #GTypeClass structure to finalize.
23069 * @class_data: The @class_data member supplied via the #GTypeInfo structure.
23071 * A callback function used by the type system to finalize a class.
23072 * This function is rarely needed, as dynamically allocated class resources
23073 * should be handled by GBaseInitFunc() and GBaseFinalizeFunc().
23074 * Also, specification of a GClassFinalizeFunc() in the #GTypeInfo
23075 * structure of a static type is invalid, because classes of static types
23076 * will never be finalized (they are artificially kept alive when their
23077 * reference count drops to zero).
23082 * GDBusInterfaceSetPropertyFunc:
23083 * @connection: A #GDBusConnection.
23084 * @sender: The unique bus name of the remote caller.
23085 * @object_path: The object path that the method was invoked on.
23086 * @interface_name: The D-Bus interface name for the property.
23087 * @property_name: The name of the property to get the value of.
23088 * @value: The value to set the property to.
23089 * @error: Return location for error.
23090 * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
23092 * The type of the @set_property function in #GDBusInterfaceVTable.
23094 * Returns: %TRUE if the property was set to @value, %FALSE if @error is set.
23100 * GWin32InputStream:handle:
23102 * The handle that the stream reads from.
23109 * GDriveStartStopType:
23110 * @G_DRIVE_START_STOP_TYPE_UNKNOWN: Unknown or drive doesn't support start/stop.
23111 * @G_DRIVE_START_STOP_TYPE_SHUTDOWN: The stop method will physically shut down the drive and e.g. power down the port the drive is attached to.
23112 * @G_DRIVE_START_STOP_TYPE_NETWORK: The start/stop methods are used for connecting/disconnect to the drive over the network.
23113 * @G_DRIVE_START_STOP_TYPE_MULTIDISK: The start/stop methods will assemble/disassemble a virtual drive from several physical drives.
23114 * @G_DRIVE_START_STOP_TYPE_PASSWORD: The start/stop methods will unlock/lock the disk (for example using the ATA <quote>SECURITY UNLOCK DEVICE</quote> command)
23116 * Enumeration describing how a drive can be started/stopped.
23125 * The #GDBusServer structure contains only private data and
23126 * should only be accessed using the provided API.
23133 * g_win32_output_stream_get_close_handle:
23134 * @stream: a #GWin32OutputStream
23136 * Returns whether the handle of @stream will be closed when the
23137 * stream is closed.
23139 * Returns: %TRUE if the handle is closed when done
23145 * g_file_eject_mountable_with_operation_finish:
23146 * @file: input #GFile.
23147 * @result: a #GAsyncResult.
23148 * @error: a #GError, or %NULL
23150 * Finishes an asynchronous eject operation started by
23151 * g_file_eject_mountable_with_operation().
23154 * Returns: %TRUE if the @file was ejected successfully. %FALSE
23160 * g_socket_client_set_family:
23161 * @client: a #GSocketClient.
23162 * @family: a #GSocketFamily
23164 * Sets the socket family of the socket client.
23165 * If this is set to something other than %G_SOCKET_FAMILY_INVALID
23166 * then the sockets created by this object will be of the specified
23168 * This might be useful for instance if you want to force the local
23169 * connection to be an ipv4 socket, even though the address might
23170 * be an ipv6 mapped to ipv4 address.
23177 * g_vfs_parse_name:
23179 * @parse_name: a string to be parsed by the VFS module.
23181 * This operation never fails, but the returned object might
23182 * not support any I/O operations if the @parse_name cannot
23183 * be parsed by the #GVfs module.
23184 * Free the returned object with g_object_unref().
23186 * Returns: (transfer full): a #GFile for the given @parse_name.
23191 * g_application_command_line_get_environ:
23192 * @cmdline: a #GApplicationCommandLine
23194 * Gets the contents of the 'environ' variable of the command line
23195 * invocation, as would be returned by g_get_environ(). The strings may
23196 * contain non-utf8 data.
23197 * The remote application usually does not send an environment. Use
23198 * %G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag
23199 * set it is possible that the environment is still not available (due
23200 * to invocation messages from other applications).
23201 * The return value should not be modified or freed and is valid for as
23202 * long as @cmdline exists.
23203 * strings, or %NULL if they were not sent
23205 * Returns: (array zero-terminated=1) (transfer none): the environment
23211 * GSocketServiceClass:
23212 * @incomming: signal emitted when new connections are accepted
23219 * g_srv_target_free:
23220 * @target: a #GSrvTarget
23231 * An implementation of #GIcon for themed icons.
23236 * GConverterResult:
23237 * @G_CONVERTER_ERROR: There was an error during conversion.
23238 * @G_CONVERTER_CONVERTED: Some data was consumed or produced
23239 * @G_CONVERTER_FINISHED: The conversion is finished
23240 * @G_CONVERTER_FLUSHED: Flushing is finished
23242 * Results returned from g_converter_convert().
23249 * g_content_type_guess_for_tree:
23250 * @root: the root of the tree to guess a type for
23252 * Tries to guess the type of the tree with root @root, by
23253 * looking at the files it contains. The result is an array
23254 * of content types, with the best guess coming first.
23255 * The types returned all have the form x-content/foo, e.g.
23256 * x-content/audio-cdda (for audio CDs) or x-content/image-dcf
23257 * (for a camera memory card). See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
23258 * specification for more on x-content types.
23259 * This function is useful in the implementation of
23260 * g_mount_guess_content_type().
23261 * array of zero or more content types, or %NULL. Free with g_strfreev()
23263 * Returns: (transfer full) (array zero-terminated=1): an %NULL-terminated
23269 * g_drive_eject_with_operation_finish:
23270 * @drive: a #GDrive.
23271 * @result: a #GAsyncResult.
23272 * @error: a #GError location to store the error occuring, or %NULL to ignore.
23274 * Finishes ejecting a drive. If any errors occurred during the operation,
23276 * Returns: %TRUE if the drive was successfully ejected. %FALSE otherwise.
23282 * g_file_load_contents_finish:
23283 * @file: input #GFile.
23284 * @res: a #GAsyncResult.
23285 * @contents: (out) (transfer full): a location to place the contents of the file.
23286 * @length: (out) (allow-none): a location to place the length of the contents of the file, or %NULL if the length is not needed
23287 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file, or %NULL if the entity tag is not needed
23288 * @error: a #GError, or %NULL
23290 * Finishes an asynchronous load of the @file's contents.
23291 * The contents are placed in @contents, and @length is set to the
23292 * size of the @contents string. The @content should be freed with
23293 * g_free() when no longer needed. If @etag_out is present, it will be
23294 * set to the new entity tag for the @file.
23295 * present, it will be set appropriately.
23297 * Returns: %TRUE if the load was successful. If %FALSE and @error is
23302 * g_tls_backend_get_client_connection_type:
23303 * @backend: the #GTlsBackend
23305 * Gets the #GType of @backend's #GTlsClientConnection implementation.
23308 * Returns: the #GType of @backend's #GTlsClientConnection
23314 * G_DATALIST_FLAGS_MASK:
23316 * A bitmask that restricts the possible flags passed to
23317 * g_datalist_set_flags(). Passing a flags value where
23318 * flags & ~G_DATALIST_FLAGS_MASK != 0 is an error.
23323 * g_dbus_address_get_stream_sync:
23324 * @address: A valid D-Bus address.
23325 * @out_guid: %NULL or return location to store the GUID extracted from @address, if any.
23326 * @cancellable: A #GCancellable or %NULL.
23327 * @error: Return location for error or %NULL.
23329 * Synchronously connects to an endpoint specified by @address and
23330 * sets up the connection so it is in a state to run the client-side
23331 * of the D-Bus authentication conversation.
23332 * This is a synchronous failable function. See
23333 * g_dbus_address_get_stream() for the asynchronous version.
23335 * Returns: (transfer full): A #GIOStream or %NULL if @error is set.
23341 * g_application_command_line_set_exit_status:
23342 * @cmdline: a #GApplicationCommandLine
23343 * @exit_status: the exit status
23345 * Sets the exit status that will be used when the invoking process
23347 * The return value of the #GApplication::command-line signal is
23348 * passed to this function when the handler returns. This is the usual
23349 * way of setting the exit status.
23350 * In the event that you want the remote invocation to continue running
23351 * and want to decide on the exit status in the future, you can use this
23352 * call. For the case of a remote invocation, the remote process will
23353 * typically exit when the last reference is dropped on @cmdline. The
23354 * exit status of the remote process will be equal to the last value
23355 * that was set with this function.
23356 * In the case that the commandline invocation is local, the situation
23357 * is slightly more complicated. If the commandline invocation results
23358 * increased to a non-zero value) then the application is considered to
23359 * have been 'successful' in a certain sense, and the exit status is
23360 * always zero. If the application use count is zero, though, the exit
23361 * status of the local #GApplicationCommandLine is used.
23363 * In the mainloop running (ie: because the use-count of the application
23369 * G_INITIALLY_UNOWNED_CLASS:
23370 * @class: a valid #GInitiallyUnownedClass
23372 * Casts a derived #GInitiallyUnownedClass structure into a
23373 * #GInitiallyUnownedClass structure.
23378 * GDBusConnection:authentication-observer:
23380 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
23387 * g_zlib_compressor_get_file_info:
23388 * @compressor: a #GZlibCompressor
23390 * Returns the #GZlibCompressor:file-info property.
23392 * Returns: (transfer none): a #GFileInfo, or %NULL
23398 * GMemoryOutputStream:size:
23400 * Current size of the data buffer.
23407 * G_VALUE_HOLDS_LONG:
23408 * @value: a valid #GValue structure
23410 * Checks whether the given #GValue can hold values of type %G_TYPE_LONG.
23412 * Returns: %TRUE on success.
23417 * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE:
23419 * A key in the "mountable" namespace for getting the unix device file.
23420 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
23428 * @g_type_instance: private #GTypeInstance portion
23429 * @name: name of this parameter
23430 * @flags: #GParamFlags flags for this parameter
23431 * @value_type: the #GValue type for this parameter
23432 * @owner_type: #GType type that uses (introduces) this parameter
23434 * All other fields of the <structname>GParamSpec</structname> struct are private and
23435 * should not be used directly.
23440 * GApplication::command-line:
23441 * @application: the application
23442 * @command_line: a #GApplicationCommandLine representing the passed commandline
23444 * The ::command-line signal is emitted on the primary instance when
23445 * a commandline is not handled locally. See g_application_run() for
23446 * more information.
23451 * GObjectFinalizeFunc:
23452 * @object: the #GObject being finalized
23454 * The type of the @finalize function of #GObjectClass.
23459 * g_socket_client_connect_finish:
23460 * @client: a #GSocketClient.
23461 * @result: a #GAsyncResult.
23462 * @error: a #GError location to store the error occuring, or %NULL to ignore.
23464 * Finishes an async connect operation. See g_socket_client_connect_async()
23466 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
23472 * g_file_query_file_type:
23473 * @file: input #GFile.
23474 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info().
23475 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
23477 * Utility function to inspect the #GFileType of a file. This is
23478 * implemented using g_file_query_info() and as such does blocking I/O.
23479 * The primary use case of this method is to check if a file is a regular file,
23480 * directory, or symlink.
23483 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file
23489 * g_app_info_launch_uris:
23490 * @appinfo: a #GAppInfo
23491 * @uris: (element-type utf8): a #GList containing URIs to launch.
23492 * @launch_context: (allow-none): a #GAppLaunchContext or %NULL
23493 * @error: a #GError
23495 * Launches the application. Passes @uris to the launched application
23496 * as arguments, using the optional @launch_context to get information
23497 * about the details of the launcher (like what screen it is on).
23498 * On error, @error will be set accordingly.
23499 * To lauch the application without arguments pass a %NULL @uris list.
23500 * Note that even if the launch is successful the application launched
23501 * can fail to start if it runs into problems during startup. There is
23502 * no way to detect this.
23504 * Returns: %TRUE on successful launch, %FALSE otherwise.
23509 * GDBusProxy:g-interface-info:
23511 * Ensure that interactions with this proxy conform to the given
23512 * interface. For example, when completing a method call, if the
23513 * type signature of the message isn't what's expected, the given
23514 * #GError is set. Signals that have a type signature mismatch are
23522 * GApplicationCommandLine:
23524 * The <structname>GApplicationCommandLine</structname> structure contains private
23525 * data and should only be accessed using the provided API
23532 * GTlsServerConnection:authentication-mode:
23534 * The #GTlsAuthenticationMode for the server. This can be changed
23535 * before calling g_tls_connection_handshake() if you want to
23536 * rehandshake with a different mode from the initial handshake.
23543 * G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW:
23545 * A key in the "filesystem" namespace for hinting a file manager
23546 * application whether it should preview (e.g. thumbnail) files on the
23547 * file system. The value for this key contain a
23548 * #GFilesystemPreviewType.
23553 * g_app_info_set_as_last_used_for_type:
23554 * @appinfo: a #GAppInfo.
23555 * @content_type: the content type.
23556 * @error: a #GError.
23558 * Sets the application as the last used application for a given type.
23559 * This will make the application appear as first in the list returned by
23560 * #g_app_info_get_recommended_for_type, regardless of the default application
23561 * for that content type.
23563 * Returns: %TRUE on success, %FALSE on error.
23568 * g_win32_input_stream_new:
23569 * @handle: a Win32 file handle
23570 * @close_fd: %TRUE to close the handle when done
23572 * Creates a new #GWin32InputStream for the given @fd.
23573 * If @close_handle is %TRUE, the handle will be closed
23574 * when the stream is closed.
23575 * Note that "handle" here means a Win32 HANDLE, not a "file descriptor"
23576 * as used in the Windows C libraries.
23578 * Returns: a new #GWin32InputStream
23583 * g_themed_icon_new_from_names:
23584 * @iconnames: (array length=len): an array of strings containing icon names.
23585 * @len: the length of the @iconnames array, or -1 if @iconnames is %NULL-terminated
23587 * Creates a new themed icon for @iconnames.
23589 * Returns: (transfer full): a new #GThemedIcon
23595 * @G_FILE_TYPE_UNKNOWN: File's type is unknown.
23596 * @G_FILE_TYPE_REGULAR: File handle represents a regular file.
23597 * @G_FILE_TYPE_DIRECTORY: File handle represents a directory.
23598 * @G_FILE_TYPE_SYMBOLIC_LINK: File handle represents a symbolic link (Unix systems).
23599 * @G_FILE_TYPE_SPECIAL: File is a "special" file, such as a socket, fifo, block device, or character device.
23600 * @G_FILE_TYPE_SHORTCUT: File is a shortcut (Windows systems).
23601 * @G_FILE_TYPE_MOUNTABLE: File is a mountable location.
23603 * Indicates the file's on-disk type.
23608 * GMountOperation::reply:
23609 * @op: a #GMountOperation.
23610 * @result: a #GMountOperationResult indicating how the request was handled
23612 * Emitted when the user has replied to the mount operation.
23617 * g_dbus_method_info_unref:
23618 * @info: A #GDBusMethodInfo.
23620 * If @info is statically allocated, does nothing. Otherwise decreases
23621 * the reference count of @info. When its reference count drops to 0,
23622 * the memory used is freed.
23629 * g_initable_new_valist:
23630 * @object_type: a #GType supporting #GInitable.
23631 * @first_property_name: the name of the first property, followed by the value, and other property value pairs, and ended by %NULL.
23632 * @var_args: The var args list generated from @first_property_name.
23633 * @cancellable: optional #GCancellable object, %NULL to ignore.
23634 * @error: a #GError location to store the error occuring, or %NULL to ignore.
23636 * Helper function for constructing #GInitiable object. This is
23637 * similar to g_object_new_valist() but also initializes the object
23638 * and returns %NULL, setting an error on failure.
23640 * Returns: (transfer full): a newly allocated #GObject, or %NULL on error
23647 * @socket: a #GSocket.
23648 * @cancellable: (allow-none): a %GCancellable or %NULL
23649 * @error: #GError for error reporting, or %NULL to ignore.
23651 * Accept incoming connections on a connection-based socket. This removes
23652 * the first outstanding connection request from the listening socket and
23653 * creates a #GSocket object for it.
23654 * The @socket must be bound to a local address with g_socket_bind() and
23655 * must be listening for incoming connections (g_socket_listen()).
23656 * If there are no outstanding connections then the operation will block
23657 * or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled.
23658 * To be notified of an incoming connection, wait for the %G_IO_IN condition.
23659 * Free the returned object with g_object_unref().
23661 * Returns: (transfer full): a new #GSocket, or %NULL on error.
23667 * g_socket_address_get_native_size:
23668 * @address: a #GSocketAddress
23670 * Gets the size of @address's native <type>struct sockaddr</type>.
23671 * You can use this to allocate memory to pass to
23672 * g_socket_address_to_native().
23674 * Returns: the size of the native <type>struct sockaddr</type> that
23680 * g_file_stop_mountable:
23681 * @file: input #GFile.
23682 * @flags: flags affecting the operation
23683 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
23684 * @cancellable: optional #GCancellable object, %NULL to ignore.
23685 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
23686 * @user_data: the data to pass to callback function
23688 * Stops a file of type G_FILE_TYPE_MOUNTABLE.
23689 * If @cancellable is not %NULL, then the operation can be cancelled by
23690 * triggering the cancellable object from another thread. If the operation
23691 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
23692 * When the operation is finished, @callback will be called. You can then call
23693 * g_file_stop_mountable_finish() to get the result of the operation.
23700 * GParamSpecOverride:
23702 * This is a type of #GParamSpec type that simply redirects operations to
23703 * another paramspec. All operations other than getting or
23704 * setting the value are redirected, including accessing the nick and
23705 * blurb, validating a value, and so forth. See
23706 * g_param_spec_get_redirect_target() for retrieving the overidden
23707 * property. #GParamSpecOverride is used in implementing
23708 * g_object_class_override_property(), and will not be directly useful
23709 * unless you are implementing a new base type similar to GObject.
23716 * g_dbus_signal_info_unref:
23717 * @info: A #GDBusSignalInfo.
23719 * If @info is statically allocated, does nothing. Otherwise decreases
23720 * the reference count of @info. When its reference count drops to 0,
23721 * the memory used is freed.
23728 * GSettingsGetMapping:
23729 * @value: the #GVariant to map, or %NULL
23730 * @result: the result of the mapping
23731 * @user_data: the user data that was passed to g_settings_get_mapped()
23732 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
23734 * The type of the function that is used to convert from a value stored
23735 * in a #GSettings to a value that is useful to the application.
23736 * If the value is successfully mapped, the result should be stored at
23737 * is not in the right format) then %FALSE should be returned.
23738 * If @value is %NULL then it means that the mapping function is being
23739 * given a "last chance" to successfully return a valid value. %TRUE
23740 * must be returned in this case.
23745 * g_file_info_get_modification_time:
23746 * @info: a #GFileInfo.
23747 * @result: a #GTimeVal.
23749 * Gets the modification time of the current @info and sets it
23755 * g_dbus_proxy_get_name_owner:
23756 * @proxy: A #GDBusProxy.
23758 * The unique name that owns the name that @proxy is for or %NULL if
23759 * no-one currently owns that name. You may connect to the
23760 * #GObject::notify signal to track changes to the
23761 * #GDBusProxy:g-name-owner property.
23763 * Returns: The name owner or %NULL if no name owner exists. Free with g_free().
23769 * GInetAddress:is-link-local:
23771 * Whether this is a link-local address.
23772 * See g_inet_address_get_is_link_local().
23779 * g_io_stream_close_async:
23780 * @stream: a #GIOStream
23781 * @io_priority: the io priority of the request
23782 * @cancellable: (allow-none): optional cancellable object
23783 * @callback: (scope async): callback to call when the request is satisfied
23784 * @user_data: (closure): the data to pass to callback function
23786 * Requests an asynchronous close of the stream, releasing resources
23787 * related to it. When the operation is finished @callback will be
23788 * called. You can then call g_io_stream_close_finish() to get
23789 * the result of the operation.
23790 * For behaviour details see g_io_stream_close().
23791 * The asynchronous methods have a default fallback that uses threads
23792 * to implement asynchronicity, so they are optional for inheriting
23793 * classes. However, if you override one you must override all.
23800 * GVolumeMonitor::drive-eject-button:
23801 * @volume_monitor: The volume monitor emitting the signal.
23802 * @drive: the drive where the eject button was pressed
23804 * Emitted when the eject button is pressed on @drive.
23811 * G_PARAM_SPEC_GET_CLASS:
23812 * @pspec: a valid #GParamSpec
23814 * Retrieves the #GParamSpecClass of a #GParamSpec.
23819 * SECTION:gresolve:
23820 * @short_description: Asynchronous and cancellable DNS resolver
23821 * @include: gio/gio.h
23823 * #GResolver provides cancellable synchronous and asynchronous DNS
23824 * resolution, for hostnames (g_resolver_lookup_by_address(),
23825 * g_resolver_lookup_by_name() and their async variants) and SRV
23826 * (service) records (g_resolver_lookup_service()).
23827 * #GNetworkAddress and #GNetworkService provide wrappers around
23828 * #GResolver functionality that also implement #GSocketConnectable,
23829 * making it easy to connect to a remote host/service.
23834 * g_action_activate:
23835 * @action: a #GAction
23836 * @parameter: (allow-none): the parameter to the activation
23838 * Activates the action.
23839 * the parameter type given at construction time). If the parameter
23840 * type was %NULL then @parameter must also be %NULL.
23847 * g_dbus_proxy_get_interface_name:
23848 * @proxy: A #GDBusProxy.
23850 * Gets the D-Bus interface name @proxy is for.
23852 * Returns: A string owned by @proxy. Do not free.
23858 * g_file_info_set_attribute_string:
23859 * @info: a #GFileInfo.
23860 * @attribute: a file attribute key.
23861 * @attr_value: a string.
23863 * Sets the @attribute to contain the given @attr_value,
23870 * @loop: a #GMainLoop
23872 * Runs a main loop until it stops running.
23874 * Deprecated: 2.2: Use g_main_loop_run() instead
23879 * g_dbus_proxy_set_default_timeout:
23880 * @proxy: A #GDBusProxy.
23881 * @timeout_msec: Timeout in milliseconds.
23883 * Sets the timeout to use if -1 (specifying default timeout) is
23884 * passed as @timeout_msec in the g_dbus_proxy_call() and
23885 * g_dbus_proxy_call_sync() functions.
23886 * See the #GDBusProxy:g-default-timeout property for more details.
23893 * GSettings::writable-changed:
23894 * @settings: the object on which the signal was emitted
23897 * The "writable-changed" signal is emitted when the writability of a
23898 * key has potentially changed. You should call
23899 * g_settings_is_writable() in order to determine the new status.
23900 * This signal supports detailed connections. You can connect to the
23901 * detailed signal "writable-changed::x" in order to only receive
23902 * callbacks when the writability of "x" changes.
23907 * g_cancellable_reset:
23908 * @cancellable: a #GCancellable object.
23910 * Resets @cancellable to its uncancelled state.
23915 * G_TYPE_PARAM_FLOAT:
23917 * The #GType of #GParamSpecFloat.
23922 * g_unix_mount_monitor_new:
23924 * Gets a new #GUnixMountMonitor. The default rate limit for which the
23925 * monitor will report consecutive changes for the mount and mount
23926 * point entry files is the default for a #GFileMonitor. Use
23927 * g_unix_mount_monitor_set_rate_limit() to change this.
23929 * Returns: a #GUnixMountMonitor.
23934 * g_socket_client_set_tls:
23935 * @client: a #GSocketClient.
23936 * @tls: whether to use TLS
23938 * Sets whether @client creates TLS (aka SSL) connections. If @tls is
23939 * %TRUE, @client will wrap its connections in a #GTlsClientConnection
23940 * and perform a TLS handshake when connecting.
23941 * Note that since #GSocketClient must return a #GSocketConnection,
23942 * but #GTlsClientConnection is not a #GSocketConnection, this
23943 * actually wraps the resulting #GTlsClientConnection in a
23944 * #GTcpWrapperConnection when returning it. You can use
23945 * g_tcp_wrapper_connection_get_base_io_stream() on the return value
23946 * to extract the #GTlsClientConnection.
23953 * GMountOperation:username:
23955 * The user name that is used for authentication when carrying out
23956 * the mount operation.
23961 * G_IS_PARAM_SPEC_CLASS:
23962 * @pclass: a #GParamSpecClass
23964 * Checks whether @pclass "is a" valid #GParamSpecClass structure of type
23965 * %G_TYPE_PARAM or derived.
23970 * g_dbus_annotation_info_ref:
23971 * @info: A #GDBusNodeInfo
23973 * If @info is statically allocated does nothing. Otherwise increases
23974 * the reference count.
23976 * Returns: The same @info.
23982 * g_pollable_output_stream_create_source: (skip)
23983 * @stream: a #GPollableOutputStream.
23984 * @cancellable: (allow-none): a #GCancellable, or %NULL
23986 * Creates a #GSource that triggers when @stream can be written, or
23987 * source is of the #GPollableSourceFunc type.
23988 * As with g_pollable_output_stream_is_writable(), it is possible that
23989 * the stream may not actually be writable even after the source
23990 * triggers, so you should use g_pollable_output_stream_write_nonblocking()
23991 * rather than g_output_stream_write() from the callback.
23993 * Returns: (transfer full): a new #GSource
23999 * g_file_info_set_attribute:
24000 * @info: a #GFileInfo.
24001 * @attribute: a file attribute key.
24002 * @type: a #GFileAttributeType
24003 * @value_p: pointer to the value
24005 * Sets the @attribute to contain the given value, if possible.
24011 * @G_TYPE_FLAG_ABSTRACT: Indicates an abstract type. No instances can be created for an abstract type.
24012 * @G_TYPE_FLAG_VALUE_ABSTRACT: Indicates an abstract value type, i.e. a type that introduces a value table, but can't be used for g_value_init().
24014 * Bit masks used to check or determine characteristics of a type.
24019 * G_FILE_ATTRIBUTE_UNIX_MODE:
24021 * A key in the "unix" namespace for getting the mode of the file
24022 * (e.g. whether the file is a regular file, symlink, etc). See lstat()
24023 * documentation. This attribute is only available for UNIX file systems.
24024 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
24031 * The fundamental type corresponding to #guint64.
24036 * G_FILE_ATTRIBUTE_TIME_MODIFIED:
24038 * A key in the "time" namespace for getting the time the file was last
24039 * modified. Corresponding #GFileAttributeType is
24040 * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
24041 * file was modified.
24046 * GTypePluginCompleteInterfaceInfo:
24047 * @plugin: the #GTypePlugin
24048 * @instance_type: the #GType of an instantiable type to which the interface is added
24049 * @interface_type: the #GType of the interface whose info is completed
24050 * @info: the #GInterfaceInfo to fill in
24052 * The type of the @complete_interface_info function of #GTypePluginClass.
24057 * SECTION:gpermissio:
24058 * @title: GPermission
24059 * @short_description: An object representing the permission to perform a certain action
24061 * A #GPermission represents the status of the caller's permission to
24062 * perform a certain action.
24063 * You can query if the action is currently allowed and if it is
24064 * possible to acquire the permission so that the action will be allowed
24066 * There is also an API to actually acquire the permission and one to
24068 * As an example, a #GPermission might represent the ability for the
24069 * user to write to a #GSettings object. This #GPermission object could
24070 * then be used to decide if it is appropriate to show a "Click here to
24071 * unlock" button in a dialog and to provide the mechanism to invoke
24072 * when that button is clicked.
24079 * TLS connection. This is an abstract type that will be subclassed by
24080 * a TLS-library-specific subtype.
24087 * g_permission_acquire:
24088 * @permission: a #GPermission instance
24089 * @cancellable: a #GCancellable, or %NULL
24090 * @error: a pointer to a %NULL #GError, or %NULL
24091 * @returns: %TRUE if the permission was successfully acquired
24093 * Attempts to acquire the permission represented by @permission.
24094 * The precise method by which this happens depends on the permission
24095 * and the underlying authentication mechanism. A simple example is
24096 * that a dialog may appear asking the user to enter their password.
24097 * You should check with g_permission_get_can_acquire() before calling
24099 * If the permission is acquired then %TRUE is returned. Otherwise,
24100 * %FALSE is returned and @error is set appropriately.
24101 * This call is blocking, likely for a very long time (in the case that
24102 * user interaction is required). See g_permission_acquire_async() for
24103 * the non-blocking version.
24110 * g_file_enumerator_next_files_async:
24111 * @enumerator: a #GFileEnumerator.
24112 * @num_files: the number of file info objects to request
24113 * @io_priority: the <link linkend="gioscheduler">io priority</link> of the request.
24114 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
24115 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
24116 * @user_data: (closure): the data to pass to callback function
24118 * Request information for a number of files from the enumerator asynchronously.
24119 * When all i/o for the operation is finished the @callback will be called with
24120 * the requested information.
24121 * The callback can be called with less than @num_files files in case of error
24122 * or at the end of the enumerator. In case of a partial error the callback will
24123 * be called with any succeeding items and no error, and on the next request the
24124 * error will be reported. If a request is cancelled the callback will be called
24125 * with %G_IO_ERROR_CANCELLED.
24126 * During an async request no other sync and async calls are allowed, and will
24127 * result in %G_IO_ERROR_PENDING errors.
24128 * Any outstanding i/o request with higher priority (lower numerical value) will
24129 * be executed before an outstanding request with lower priority. Default
24130 * priority is %G_PRIORITY_DEFAULT.
24135 * g_file_enumerate_children_async:
24136 * @file: input #GFile.
24137 * @attributes: an attribute query string.
24138 * @flags: a set of #GFileQueryInfoFlags.
24139 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
24140 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
24141 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
24142 * @user_data: (closure): the data to pass to callback function
24144 * Asynchronously gets the requested information about the files in a directory. The result
24145 * is a #GFileEnumerator object that will give out #GFileInfo objects for
24146 * all the files in the directory.
24147 * For more details, see g_file_enumerate_children() which is
24148 * the synchronous version of this call.
24149 * When the operation is finished, @callback will be called. You can then call
24150 * g_file_enumerate_children_finish() to get the result of the operation.
24155 * g_action_group_action_removed:
24156 * @action_group: a #GActionGroup
24157 * @action_name: the name of an action in the group
24159 * Emits the #GActionGroup::action-removed signal on @action_group.
24160 * This function should only be called by #GActionGroup implementations.
24167 * g_file_info_set_file_type:
24168 * @info: a #GFileInfo.
24169 * @type: a #GFileType.
24171 * Sets the file type in a #GFileInfo to @type.
24172 * See %G_FILE_ATTRIBUTE_STANDARD_TYPE.
24177 * g_data_input_stream_read_int16:
24178 * @stream: a given #GDataInputStream.
24179 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
24180 * @error: #GError for error reporting.
24182 * Reads a 16-bit/2-byte value from @stream.
24183 * In order to get the correct byte order for this read operation,
24184 * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
24185 * an error occurred.
24187 * Returns: a signed 16-bit/2-byte value read from @stream or %0 if
24193 * @type: a #GType ID.
24195 * Checks whether @type "is a" %G_TYPE_FLAGS.
24197 * Returns: %TRUE if @type "is a" %G_TYPE_FLAGS.
24202 * SECTION:gdbusintrospectio:
24203 * @title: D-Bus Introspection Data
24204 * @short_description: Node and interface description data structures
24205 * @include: gio/gio.h
24207 * Various data structures and convenience routines to parse and
24208 * generate D-Bus introspection XML. Introspection information is
24209 * used when registering objects with g_dbus_connection_register_object().
24210 * The format of D-Bus introspection XML is specified in the
24211 * <link linkend="http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format">D-Bus specification</link>.
24216 * G_FILE_ATTRIBUTE_UNIX_BLOCKS:
24218 * A key in the "unix" namespace for getting the number of blocks allocated
24219 * for the file. This attribute is only available for UNIX file systems.
24220 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
24225 * g_srv_target_list_sort: (skip)
24226 * @targets: a #GList of #GSrvTarget
24228 * Sorts @targets in place according to the algorithm in RFC 2782.
24230 * Returns: (transfer full): the head of the sorted list.
24236 * G_DEFINE_TYPE_EXTENDED:
24237 * @TN: The name of the new type, in Camel case.
24238 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
24239 * @T_P: The #GType of the parent type.
24240 * @_f_: #GTypeFlags to pass to g_type_register_static()
24241 * @_C_: Custom code that gets inserted in the *_get_type() function.
24243 * The most general convenience macro for type implementations, on which
24244 * G_DEFINE_TYPE(), etc are based.
24246 * G_DEFINE_TYPE_EXTENDED (GtkGadget,
24250 * G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
24251 * gtk_gadget_gizmo_init));
24255 * static void gtk_gadget_init (GtkGadget *self);
24256 * static void gtk_gadget_class_init (GtkGadgetClass *klass);
24257 * static gpointer gtk_gadget_parent_class = NULL;
24258 * static void gtk_gadget_class_intern_init (gpointer klass)
24260 * gtk_gadget_parent_class = g_type_class_peek_parent (klass);
24261 * gtk_gadget_class_init ((GtkGadgetClass*) klass);
24264 * gtk_gadget_get_type (void)
24266 * static volatile gsize g_define_type_id__volatile = 0;
24267 * if (g_once_init_enter (&g_define_type_id__volatile))
24269 * GType g_define_type_id =
24270 * g_type_register_static_simple (GTK_TYPE_WIDGET,
24271 * g_intern_static_string ("GtkGadget"),
24272 * sizeof (GtkGadgetClass),
24273 * (GClassInitFunc) gtk_gadget_class_intern_init,
24274 * sizeof (GtkGadget),
24275 * (GInstanceInitFunc) gtk_gadget_init,
24276 * (GTypeFlags) flags);
24278 * static const GInterfaceInfo g_implement_interface_info = {
24279 * (GInterfaceInitFunc) gtk_gadget_gizmo_init
24281 * g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
24283 * g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
24285 * return g_define_type_id__volatile;
24288 * The only pieces which have to be manually provided are the definitions of
24289 * the instance and class structure and the definitions of the instance and
24290 * class init functions.
24297 * g_credentials_set_native:
24298 * @credentials: A #GCredentials.
24299 * @native_type: The type of native credentials to set.
24300 * @native: A pointer to native credentials.
24302 * Copies the native credentials of type @native_type from @native
24303 * into @credentials.
24304 * It is a programming error (which will cause an warning to be
24305 * logged) to use this method if there is no #GCredentials support for
24306 * the OS or if @native_type isn't supported by the OS.
24313 * G_TYPE_PARAM_DOUBLE:
24315 * The #GType of #GParamSpecDouble.
24321 * @G_SOCKET_TYPE_INVALID: Type unknown or wrong
24322 * @G_SOCKET_TYPE_STREAM: Reliable connection-based byte streams (e.g. TCP).
24323 * @G_SOCKET_TYPE_DATAGRAM: Connectionless, unreliable datagram passing. (e.g. UDP)
24324 * @G_SOCKET_TYPE_SEQPACKET: Reliable connection-based passing of datagrams of fixed maximum length (e.g. SCTP).
24326 * Flags used when creating a #GSocket. Some protocols may not implement
24327 * all the socket types.
24334 * g_dbus_connection_get_stream:
24335 * @connection: a #GDBusConnection
24337 * Gets the underlying stream used for IO.
24339 * Returns: (transfer none): the stream used for IO
24345 * g_network_service_new:
24346 * @service: the service type to look up (eg, "ldap")
24347 * @protocol: the networking protocol to use for @service (eg, "tcp")
24348 * @domain: the DNS domain to look up the service in
24350 * Creates a new #GNetworkService representing the given @service,
24351 * #GSocketConnectable interface to resolve it.
24353 * Returns: (transfer full): a new #GNetworkService
24359 * GApplicationClass:
24360 * @startup: invoked on the primary instance immediately after registration
24361 * @activate: invoked on the primary instance when an activation occurs
24362 * @open: invoked on the primary instance when there are files to open
24363 * @command_line: invoked on the primary instance when a command-line is not handled locally
24364 * @local_command_line: invoked (locally) when the process has been invoked via commandline execution. The virtual function has the chance to inspect (and possibly replace) the list of command line arguments. See g_application_run() for more information.
24365 * @before_emit: invoked on the primary instance before 'activate', 'open' or any action invocation
24366 * @after_emit: invoked on the primary instance after 'activate', 'open' or any action invocation
24367 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to the primary instance when activating, opening or invoking actions
24368 * @quit_mainloop: invoked on the primary instance when the use count of the application drops to zero (and after any inactivity timeout, if requested)
24369 * @run_mainloop: invoked on the primary instance from g_application_run() if the use-count is non-zero
24378 * GSignalAccumulator:
24379 * @ihint: Signal invocation hint, see #GSignalInvocationHint.
24380 * @return_accu: Accumulator to collect callback return values in, this is the return value of the current signal emission.
24381 * @handler_return: A #GValue holding the return value of the signal handler.
24382 * @data: Callback data that was specified when creating the signal.
24384 * The signal accumulator is a special callback function that can be used
24385 * to collect return values of the various callbacks that are called
24386 * during a signal emission. The signal accumulator is specified at signal
24387 * creation time, if it is left %NULL, no accumulation of callback return
24388 * values is performed. The return value of signal emissions is then the
24389 * value returned by the last callback.
24390 * should be aborted. Returning %FALSE means to abort the
24391 * current emission and %TRUE is returned for continuation.
24393 * Returns: The accumulator function returns whether the signal emission
24398 * g_credentials_new:
24400 * Creates a new #GCredentials object with credentials matching the
24401 * the current process.
24403 * Returns: A #GCredentials. Free with g_object_unref().
24409 * SECTION:ginitabl:
24410 * @short_description: Failable object initialization interface
24411 * @include: gio/gio.h
24412 * @see_also: #GAsyncInitable
24414 * #GInitable is implemented by objects that can fail during
24415 * initialization. If an object implements this interface the
24416 * g_initable_init() function must be called as the first thing
24417 * after construction. If g_initable_init() is not called, or if
24418 * it returns an error, all further operations on the object
24419 * should fail, generally with a %G_IO_ERROR_NOT_INITIALIZED error.
24420 * Users of objects implementing this are not intended to use
24421 * the interface method directly, instead it will be used automatically
24422 * in various ways. For C applications you generally just call
24423 * g_initable_new() directly, or indirectly via a foo_thing_new() wrapper.
24424 * This will call g_initable_init() under the cover, returning %NULL and
24425 * setting a %GError on failure.
24426 * For bindings in languages where the native constructor supports
24427 * exceptions the binding could check for objects implemention %GInitable
24428 * during normal construction and automatically initialize them, throwing
24429 * an exception on failure.
24435 * @TN: The name of the new type, in Camel case.
24436 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
24437 * @T_P: The #GType of the parent type.
24439 * A convenience macro for type implementations, which declares a
24440 * class initialization function, an instance initialization function (see #GTypeInfo for information about
24441 * these) and a static variable named @t_n<!-- -->_parent_class pointing to the parent class. Furthermore, it defines
24442 * a *_get_type() function. See G_DEFINE_TYPE_EXTENDED() for an example.
24449 * g_file_info_get_file_type:
24450 * @info: a #GFileInfo.
24452 * Gets a file's type (whether it is a regular file, symlink, etc).
24453 * This is different from the file's content type, see g_file_info_get_content_type().
24455 * Returns: a #GFileType for the given file.
24460 * GFilterInputStream:
24462 * A base class for all input streams that work on an underlying stream.
24467 * g_dbus_node_info_generate_xml:
24468 * @info: A #GDBusNodeInfo.
24469 * @indent: Indentation level.
24470 * @string_builder: A #GString to to append XML data to.
24472 * Appends an XML representation of @info (and its children) to @string_builder.
24473 * This function is typically used for generating introspection XML documents at run-time for
24474 * handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method.
24481 * g_dbus_is_interface_name:
24482 * @string: The string to check.
24484 * Checks if @string is a valid D-Bus interface name.
24486 * Returns: %TRUE if valid, %FALSE otherwise.
24492 * GUnixMountMonitor::mounts-changed:
24493 * @monitor: the object on which the signal is emitted
24495 * Emitted when the unix mounts have changed.
24500 * g_dbus_address_get_for_bus_sync:
24501 * @bus_type: A #GBusType.
24502 * @cancellable: A #GCancellable or %NULL.
24503 * @error: Return location for error or %NULL.
24505 * Synchronously looks up the D-Bus address for the well-known message
24506 * bus instance specified by @bus_type. This may involve using various
24507 * platform specific mechanisms.
24509 * Returns: A valid D-Bus address string for @bus_type or %NULL if @error is set.
24515 * G_VALUE_HOLDS_PARAM:
24516 * @value: a valid #GValue structure
24518 * Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM.
24520 * Returns: %TRUE on success.
24525 * G_PARAM_SPEC_STRING:
24526 * @pspec: a valid #GParamSpec instance
24528 * Casts a #GParamSpec instance into a #GParamSpecString.
24533 * GInetAddress:is-multicast:
24535 * Whether this is a multicast address.
24536 * See g_inet_address_get_is_multicast().
24545 * #GPermission is an opaque data structure and can only be accessed
24546 * using the following functions.
24551 * g_filename_completer_new:
24553 * Creates a new filename completer.
24555 * Returns: a #GFilenameCompleter.
24560 * g_data_output_stream_put_int16:
24561 * @stream: a #GDataOutputStream.
24562 * @data: a #gint16.
24563 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
24564 * @error: a #GError, %NULL to ignore.
24566 * Puts a signed 16-bit integer into the output stream.
24568 * Returns: %TRUE if @data was successfully added to the @stream.
24573 * g_io_extension_point_lookup:
24574 * @name: the name of the extension point
24576 * Looks up an existing extension point.
24577 * registered extension point with the given name
24579 * Returns: the #GIOExtensionPoint, or %NULL if there is no
24584 * g_dbus_connection_send_message_with_reply_sync:
24585 * @connection: A #GDBusConnection.
24586 * @message: A #GDBusMessage.
24587 * @flags: Flags affecting how the message is sent.
24588 * @timeout_msec: The timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout.
24589 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
24590 * @cancellable: A #GCancellable or %NULL.
24591 * @error: Return location for error or %NULL.
24593 * Synchronously sends @message to the peer represented by @connection
24594 * and blocks the calling thread until a reply is received or the
24595 * timeout is reached. See g_dbus_connection_send_message_with_reply()
24596 * for the asynchronous version of this method.
24597 * Unless @flags contain the
24598 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
24599 * will be assigned by @connection and set on @message via
24600 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
24601 * serial number used will be written to this location prior to
24602 * submitting the message to the underlying transport.
24603 * If @connection is closed then the operation will fail with
24604 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
24605 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
24606 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
24607 * Note that @error is only set if a local in-process error
24608 * occured. That is to say that the returned #GDBusMessage object may
24609 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
24610 * g_dbus_message_to_gerror() to transcode this to a #GError.
24611 * See <xref linkend="gdbus-server"/> and <xref
24612 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
24613 * low-level API to send and receive UNIX file descriptors.
24614 * Note that @message must be unlocked, unless @flags contain the
24615 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
24617 * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
24624 * @G_CONVERT_ERROR_NO_CONVERSION: Conversion between the requested character sets is not supported.
24625 * @G_CONVERT_ERROR_ILLEGAL_SEQUENCE: Invalid byte sequence in conversion input.
24626 * @G_CONVERT_ERROR_FAILED: Conversion failed for some reason.
24627 * @G_CONVERT_ERROR_PARTIAL_INPUT: Partial character sequence at end of input.
24628 * @G_CONVERT_ERROR_BAD_URI: URI is invalid.
24629 * @G_CONVERT_ERROR_NOT_ABSOLUTE_PATH: Pathname is not an absolute path.
24631 * Error codes returned by character set conversion routines.
24638 * Information about an installed application from a desktop file.
24643 * GObjectConstructParam:
24644 * @pspec: the #GParamSpec of the construct parameter
24645 * @value: the value to set the parameter to
24647 * The <structname>GObjectConstructParam</structname> struct is an auxiliary
24648 * structure used to hand #GParamSpec/#GValue pairs to the @constructor of
24654 * g_credentials_to_string:
24655 * @credentials: A #GCredentials object.
24657 * Creates a human-readable textual representation of @credentials
24658 * that can be used in logging and debug messages. The format of the
24659 * returned string may change in future GLib release.
24661 * Returns: A string that should be freed with g_free().
24667 * GApplicationFlags:
24668 * @G_APPLICATION_FLAGS_NONE: Default
24669 * @G_APPLICATION_IS_SERVICE: Run as a service. In this mode, registration fails if the service is already running, and the application will stay around for a while when the use count falls to zero.
24670 * @G_APPLICATION_IS_LAUNCHER: Don't try to become the primary instance.
24671 * @G_APPLICATION_HANDLES_OPEN: This application handles opening files (in the primary instance)
24672 * @G_APPLICATION_HANDLES_COMMAND_LINE: This application handles command line arguments (in the primary instance)
24673 * @G_APPLICATION_SEND_ENVIRONMENT: Send the environment of the launching process to the primary instance
24675 * Flags used to define the behaviour of a #GApplication.
24682 * g_data_input_stream_set_byte_order:
24683 * @stream: a given #GDataInputStream.
24684 * @order: a #GDataStreamByteOrder to set.
24686 * This function sets the byte order for the given @stream. All subsequent
24687 * reads from the @stream will be read in the given @order.
24693 * @f: a function pointer.
24695 * Cast a function pointer to a #GCallback.
24700 * g_dbus_message_get_locked:
24701 * @message: A #GDBusMessage.
24703 * Checks whether @message is locked. To monitor changes to this
24704 * value, conncet to the #GObject::notify signal to listen for changes
24705 * on the #GDBusMessage:locked property.
24707 * Returns: %TRUE if @message is locked, %FALSE otherwise.
24713 * G_FILE_ATTRIBUTE_GVFS_BACKEND:
24715 * A key in the "gvfs" namespace that gets the name of the current
24716 * GVFS backend in use. Corresponding #GFileAttributeType is
24717 * %G_FILE_ATTRIBUTE_TYPE_STRING.
24722 * GOptionParseFunc:
24723 * @context: The active #GOptionContext
24724 * @group: The group to which the function belongs
24725 * @data: User data added to the #GOptionGroup containing the option when it was created with g_option_group_new()
24726 * @error: A return location for error details
24728 * The type of function that can be called before and after parsing.
24729 * occurred, in which case @error should be set with g_set_error()
24731 * Returns: %TRUE if the function completed successfully, %FALSE if an error
24737 * @class: a valid #GEnumClass
24739 * Casts a derived #GEnumClass structure into a #GEnumClass structure.
24744 * GAction:state-type:
24746 * The #GVariantType of the state that the action has, or %NULL if the
24747 * action is stateless.
24755 * @value: A #GValue structure.
24757 * Get the type identifier of @value.
24759 * Returns: the #GType.
24764 * g_socket_send_with_blocking:
24765 * @socket: a #GSocket
24766 * @buffer: (array length=size): the buffer containing the data to send.
24767 * @size: the number of bytes to send
24768 * @blocking: whether to do blocking or non-blocking I/O
24769 * @cancellable: (allow-none): a %GCancellable or %NULL
24770 * @error: #GError for error reporting, or %NULL to ignore.
24772 * This behaves exactly the same as g_socket_send(), except that
24773 * the choice of blocking or non-blocking behavior is determined by
24774 * the @blocking argument rather than by @socket's properties.
24777 * Returns: Number of bytes written (which may be less than @size), or -1
24783 * GDBusCapabilityFlags:
24784 * @G_DBUS_CAPABILITY_FLAGS_NONE: No flags set.
24785 * @G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING: The connection supports exchanging UNIX file descriptors with the remote peer.
24787 * Capabilities negotiated with the remote peer.
24794 * g_unix_socket_address_abstract_names_supported:
24796 * Checks if abstract unix domain socket names are supported.
24798 * Returns: %TRUE if supported, %FALSE otherwise
24804 * G_VARIANT_TYPE_BYTESTRING:
24806 * The type of an array of bytes. This type is commonly used to pass
24807 * around strings that may not be valid utf8. In that case, the
24808 * convention is that the nul terminator character should be included as
24809 * the last character in the array.
24814 * g_bus_unwatch_name:
24815 * @watcher_id: An identifier obtained from g_bus_watch_name()
24817 * Stops watching a name.
24824 * g_socket_connectable_proxy_enumerate:
24825 * @connectable: a #GSocketConnectable
24827 * Creates a #GSocketAddressEnumerator for @connectable that will
24828 * return #GProxyAddress<!-- -->es for addresses that you must connect
24830 * If @connectable does not implement
24831 * g_socket_connectable_proxy_enumerate(), this will fall back to
24832 * calling g_socket_connectable_enumerate().
24834 * Returns: (transfer full): a new #GSocketAddressEnumerator.
24840 * g_dbus_method_invocation_get_interface_name:
24841 * @invocation: A #GDBusMethodInvocation.
24843 * Gets the name of the D-Bus interface the method was invoked on.
24845 * Returns: A string. Do not free, it is owned by @invocation.
24851 * g_memory_input_stream_new:
24853 * Creates a new empty #GMemoryInputStream.
24855 * Returns: a new #GInputStream
24860 * g_resolver_free_targets: (skip)
24861 * @targets: a #GList of #GSrvTarget
24863 * Frees @targets (which should be the return value from
24864 * g_resolver_lookup_service() or g_resolver_lookup_service_finish()).
24865 * (This is a convenience method; you can also simply free the
24866 * results by hand.)
24873 * g_cancellable_is_cancelled:
24874 * @cancellable: a #GCancellable or NULL.
24876 * Checks if a cancellable job has been cancelled.
24877 * FALSE if called with %NULL or if item is not cancelled.
24879 * Returns: %TRUE if @cancellable is cancelled,
24884 * GParamSpecVariant:
24885 * @parent_instance: private #GParamSpec portion
24886 * @type: a #GVariantType, or %NULL
24887 * @default_value: a #GVariant, or %NULL
24889 * A #GParamSpec derived structure that contains the meta data for #GVariant properties.
24896 * g_file_info_get_is_hidden:
24897 * @info: a #GFileInfo.
24899 * Checks if a file is hidden.
24901 * Returns: %TRUE if the file is a hidden file, %FALSE otherwise.
24906 * g_dbus_server_start:
24907 * @server: A #GDBusServer.
24916 * G_VOLUME_IDENTIFIER_KIND_LABEL:
24918 * The string used to obtain a filesystem label with g_volume_get_identifier().
24923 * SECTION:gsocketconnectabl:
24924 * @short_description: Interface for potential socket endpoints
24926 * Objects that describe one or more potential socket endpoints
24927 * implement #GSocketConnectable. Callers can then use
24928 * g_socket_connectable_enumerate() to get a #GSocketAddressEnumerator
24929 * to try out each socket address in turn until one succeeds, as shown
24930 * in the sample code below.
24932 * MyConnectionType *
24933 * connect_to_host (const char *hostname,
24935 * GCancellable *cancellable,
24938 * MyConnection *conn = NULL;
24939 * GSocketConnectable *addr;
24940 * GSocketAddressEnumerator *enumerator;
24941 * GSocketAddress *sockaddr;
24942 * GError *conn_error = NULL;
24943 * addr = g_network_address_new ("www.gnome.org", 80);
24944 * enumerator = g_socket_connectable_enumerate (addr);
24945 * g_object_unref (addr);
24946 * /<!-- -->* Try each sockaddr until we succeed. Record the first
24947 * * connection error, but not any further ones (since they'll probably
24948 * * be basically the same as the first).
24950 * while (!conn && (sockaddr = g_socket_address_enumerator_next (enumerator, cancellable, error))
24952 * g_object_unref (sockaddr);
24954 * g_object_unref (enumerator);
24959 * /<!-- -->* We couldn't connect to the first address, but we succeeded
24960 * * in connecting to a later address.
24962 * g_error_free (conn_error);
24968 * /<!-- -->* Either the initial lookup failed, or else the caller
24972 * g_error_free (conn_error);
24977 * g_error_propagate (error, conn_error);
24983 * Conn = connect_to_sockaddr (sockaddr, conn_error ? null : &conn_error);
24988 * g_dbus_connection_close_sync:
24989 * @connection: A #GDBusConnection.
24990 * @cancellable: A #GCancellable or %NULL.
24991 * @error: Return location for error or %NULL.
24993 * Synchronously closees @connection. The calling thread is blocked
24994 * until this is done. See g_dbus_connection_close() for the
24995 * asynchronous version of this method and more details about what it
24998 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
25004 * g_settings_get_double:
25005 * @settings: a #GSettings object
25006 * @key: the key to get the value for
25007 * @returns: a double
25009 * Gets the value that is stored at @key in @settings.
25010 * A convenience variant of g_settings_get() for doubles.
25011 * It is a programmer error to give a @key that isn't specified as
25012 * having a 'double' type in the schema for @settings.
25019 * G_IS_PARAM_SPEC_UINT64:
25020 * @pspec: a valid #GParamSpec instance
25022 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64.
25024 * Returns: %TRUE on success.
25029 * g_app_info_equal:
25030 * @appinfo1: the first #GAppInfo.
25031 * @appinfo2: the second #GAppInfo.
25033 * Checks if two #GAppInfo<!-- -->s are equal.
25035 * Returns: %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise.
25041 * @mount: a #GMount.
25042 * @flags: flags affecting the operation
25043 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
25044 * @cancellable: optional #GCancellable object, %NULL to ignore.
25045 * @callback: a #GAsyncReadyCallback, or %NULL.
25046 * @user_data: user data passed to @callback.
25048 * Remounts a mount. This is an asynchronous operation, and is
25049 * finished by calling g_mount_remount_finish() with the @mount
25050 * and #GAsyncResults data returned in the @callback.
25051 * Remounting is useful when some setting affecting the operation
25052 * of the volume has been changed, as these may need a remount to
25053 * take affect. While this is semantically equivalent with unmounting
25054 * and then remounting not all backends might need to actually be
25060 * g_volume_can_mount:
25061 * @volume: a #GVolume.
25063 * Checks if a volume can be mounted.
25065 * Returns: %TRUE if the @volume can be mounted. %FALSE otherwise.
25072 * The fundamental type corresponding to #glong.
25077 * g_volume_monitor_get:
25079 * Gets the volume monitor used by gio.
25080 * g_object_unref() when done with it.
25082 * Returns: (transfer full): a reference to the #GVolumeMonitor used by gio. Call
25087 * g_file_make_directory_with_parents:
25088 * @file: input #GFile.
25089 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
25090 * @error: a #GError, or %NULL
25092 * Creates a directory and any parent directories that may not exist similar to
25093 * 'mkdir -p'. If the file system does not support creating directories, this
25094 * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED.
25095 * For a local #GFile the newly created directories will have the default
25096 * (current) ownership and permissions of the current process.
25097 * If @cancellable is not %NULL, then the operation can be cancelled by
25098 * triggering the cancellable object from another thread. If the operation
25099 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
25102 * Returns: %TRUE if all directories have been successfully created, %FALSE
25108 * g_buffered_input_stream_peek_buffer:
25109 * @stream: a #GBufferedInputStream
25110 * @count: (out): a #gsize to get the number of bytes available in the buffer
25112 * Returns the buffer with the currently available bytes. The returned
25113 * buffer must not be modified and will become invalid when reading from
25114 * the stream or filling the buffer.
25117 * Returns: (array length=count) (element-type guint8) (transfer none):
25122 * g_socket_address_enumerator_next:
25123 * @enumerator: a #GSocketAddressEnumerator
25124 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
25125 * @error: a #GError.
25127 * Retrieves the next #GSocketAddress from @enumerator. Note that this
25128 * may block for some amount of time. (Eg, a #GNetworkAddress may need
25129 * to do a DNS lookup before it can return an address.) Use
25130 * g_socket_address_enumerator_next_async() if you need to avoid
25132 * If @enumerator is expected to yield addresses, but for some reason
25133 * is unable to (eg, because of a DNS error), then the first call to
25134 * g_socket_address_enumerator_next() will return an appropriate error
25135 * in *@error. However, if the first call to
25136 * g_socket_address_enumerator_next() succeeds, then any further
25137 * internal errors (other than @cancellable being triggered) will be
25139 * error (in which case *@error will be set) or if there are no
25142 * Returns: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on
25147 * G_PARAM_SPEC_UNICHAR:
25148 * @pspec: a valid #GParamSpec instance
25150 * Cast a #GParamSpec instance into a #GParamSpecUnichar.
25155 * G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH:
25157 * A key in the "access" namespace for checking trashing privileges.
25158 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
25159 * This attribute will be %TRUE if the user is able to move the file to
25167 * Abstract base class for TLS certificate types.
25174 * SECTION:gasyncinitabl:
25175 * @short_description: Asynchronously failable object initialization interface
25176 * @include: gio/gio.h
25177 * @see_also: #GInitable
25179 * This is the asynchronous version of #GInitable; it behaves the same
25180 * in all ways except that initialization is asynchronous. For more details
25181 * see the descriptions on #GInitable.
25182 * A class may implement both the #GInitable and #GAsyncInitable interfaces.
25183 * Users of objects implementing this are not intended to use the interface
25184 * method directly; instead it will be used automatically in various ways.
25185 * For C applications you generally just call g_async_initable_new_async()
25186 * directly, or indirectly via a foo_thing_new_async() wrapper. This will call
25187 * g_async_initable_init_async() under the cover, calling back with %NULL and
25188 * a set %GError on failure.
25189 * A typical implementation might look something like this:
25197 * _foo_ready_cb (Foo *self)
25200 * self->priv->state = INITIALIZED;
25201 * for (l = self->priv->init_results; l != NULL; l = l->next)
25203 * GSimpleAsyncResult *simple = l->data;
25204 * if (!self->priv->success)
25205 * g_simple_async_result_set_error (simple, ...);
25206 * g_simple_async_result_complete (simple);
25207 * g_object_unref (simple);
25209 * g_list_free (self->priv->init_results);
25210 * self->priv->init_results = NULL;
25213 * foo_init_async (GAsyncInitable *initable,
25215 * GCancellable *cancellable,
25216 * GAsyncReadyCallback callback,
25217 * gpointer user_data)
25219 * Foo *self = FOO (initable);
25220 * GSimpleAsyncResult *simple;
25221 * simple = g_simple_async_result_new (G_OBJECT (initable)
25225 * switch (self->priv->state)
25227 * case NOT_INITIALIZED:
25228 * _foo_get_ready (self);
25229 * self->priv->init_results = g_list_append (self->priv->init_results,
25231 * self->priv->state = INITIALIZING;
25233 * case INITIALIZING:
25234 * self->priv->init_results = g_list_append (self->priv->init_results,
25237 * case INITIALIZED:
25238 * if (!self->priv->success)
25239 * g_simple_async_result_set_error (simple, ...);
25240 * g_simple_async_result_complete_in_idle (simple);
25241 * g_object_unref (simple);
25246 * foo_init_finish (GAsyncInitable *initable,
25247 * GAsyncResult *result,
25250 * g_return_val_if_fail (g_simple_async_result_is_valid (result,
25251 * G_OBJECT (initable), foo_init_async), FALSE);
25252 * if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (result),
25258 * foo_async_initable_iface_init (gpointer g_iface,
25261 * GAsyncInitableIface *iface = g_iface;
25262 * iface->init_async = foo_init_async;
25263 * iface->init_finish = foo_init_finish;
25270 * g_file_attribute_info_list_new:
25272 * Creates a new file attribute info list.
25274 * Returns: a #GFileAttributeInfoList.
25279 * G_FILE_ATTRIBUTE_STANDARD_NAME:
25281 * A key in the "standard" namespace for getting the name of the file.
25282 * The name is the on-disk filename which may not be in any known encoding,
25283 * and can thus not be generally displayed as is.
25284 * Use #G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the
25285 * name in a user interface.
25286 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
25291 * g_resolver_lookup_by_name_finish:
25292 * @resolver: a #GResolver
25293 * @result: the result passed to your #GAsyncReadyCallback
25294 * @error: return location for a #GError, or %NULL
25296 * Retrieves the result of a call to
25297 * g_resolver_lookup_by_name_async().
25298 * If the DNS resolution failed, @error (if non-%NULL) will be set to
25299 * a value from #GResolverError. If the operation was cancelled,
25300 * of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name()
25301 * for more details.
25303 * Returns: (element-type GInetAddress) (transfer full): a #GList
25311 * A fundamental type which is used as a replacement for the C
25312 * <literal>void</literal> return type.
25317 * g_data_input_stream_get_newline_type:
25318 * @stream: a given #GDataInputStream.
25320 * Gets the current newline type for the @stream.
25322 * Returns: #GDataStreamNewlineType for the given @stream.
25327 * g_volume_eject_with_operation_finish:
25328 * @volume: a #GVolume.
25329 * @result: a #GAsyncResult.
25330 * @error: a #GError location to store the error occuring, or %NULL to ignore.
25332 * Finishes ejecting a volume. If any errors occurred during the operation,
25334 * Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise.
25340 * g_drive_can_poll_for_media:
25341 * @drive: a #GDrive.
25343 * Checks if a drive can be polled for media changes.
25344 * %FALSE otherwise.
25346 * Returns: %TRUE if the @drive can be polled for media changes,
25353 * A C representable type name for #G_TYPE_STRING.
25358 * g_dbus_error_register_error_domain:
25359 * @error_domain_quark_name: The error domain name.
25360 * @quark_volatile: A pointer where to store the #GQuark.
25361 * @entries: A pointer to @num_entries #GDBusErrorEntry struct items.
25362 * @num_entries: Number of items to register.
25364 * Helper function for associating a #GError error domain with D-Bus error names.
25371 * G_FILE_ATTRIBUTE_ID_FILE:
25373 * A key in the "id" namespace for getting a file identifier.
25374 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
25375 * An example use would be during listing files, to avoid recursive
25376 * directory scanning.
25381 * g_cancellable_release_fd:
25382 * @cancellable: a #GCancellable
25384 * Releases a resources previously allocated by g_cancellable_get_fd()
25385 * or g_cancellable_make_pollfd().
25386 * For compatibility reasons with older releases, calling this function
25387 * is not strictly required, the resources will be automatically freed
25388 * when the @cancellable is finalized. However, the @cancellable will
25389 * block scarce file descriptors until it is finalized if this function
25390 * is not called. This can cause the application to run out of file
25391 * descriptors when many #GCancellables are used at the same time.
25398 * g_data_input_stream_read_upto:
25399 * @stream: a #GDataInputStream
25400 * @stop_chars: characters to terminate the read
25401 * @stop_chars_len: length of @stop_chars. May be -1 if @stop_chars is nul-terminated
25402 * @length: (out): a #gsize to get the length of the data read in
25403 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
25404 * @error: #GError for error reporting
25406 * Reads a string from the data input stream, up to the first
25407 * occurrence of any of the stop characters.
25408 * In contrast to g_data_input_stream_read_until(), this function
25409 * does <emphasis>not</emphasis> consume the stop character. You have
25410 * to use g_data_input_stream_read_byte() to get it before calling
25411 * g_data_input_stream_read_upto() again.
25412 * Note that @stop_chars may contain '\0' if @stop_chars_len is
25414 * before encountering any of the stop characters. Set @length to
25415 * a #gsize to get the length of the string. This function will
25416 * return %NULL on an error
25418 * Returns: (transfer full): a string with the data that was read
25424 * G_PARAM_SPEC_FLOAT:
25425 * @pspec: a valid #GParamSpec instance
25427 * Cast a #GParamSpec instance into a #GParamSpecFloat.
25432 * g_inet_address_get_family:
25433 * @address: a #GInetAddress
25435 * Gets @address's family
25437 * Returns: @address's family
25443 * g_filename_completer_get_completions:
25444 * @completer: the filename completer.
25445 * @initial_text: text to be completed.
25447 * Gets an array of completion strings for a given initial text.
25448 * This array must be freed by g_strfreev() when finished.
25450 * Returns: (array zero-terminated=1) (transfer full): array of strings with possible completions for @initial_text.
25455 * g_data_output_stream_get_byte_order:
25456 * @stream: a #GDataOutputStream.
25458 * Gets the byte order for the stream.
25460 * Returns: the #GDataStreamByteOrder for the @stream.
25466 * @g_iface: The parent interface.
25467 * @hash: A hash for a given #GIcon.
25468 * @equal: Checks if two #GIcon<!-- -->s are equal.
25469 * @to_tokens: Serializes a #GIcon into tokens. The tokens must not contain any whitespace. Don't implement if the #GIcon can't be serialized (Since 2.20).
25470 * @from_tokens: Constructs a #GIcon from tokens. Set the #GError if the tokens are malformed. Don't implement if the #GIcon can't be serialized (Since 2.20).
25472 * GIconIface is used to implement GIcon types for various
25473 * different systems. See #GThemedIcon and #GLoadableIcon for
25474 * examples of how to implement this interface.
25479 * g_file_info_get_icon:
25480 * @info: a #GFileInfo.
25482 * Gets the icon for a file.
25484 * Returns: (transfer none): #GIcon for the given @info.
25489 * g_filter_output_stream_set_close_base_stream:
25490 * @stream: a #GFilterOutputStream.
25491 * @close_base: %TRUE to close the base stream.
25493 * Sets whether the base stream will be closed when @stream is closed.
25498 * g_file_set_display_name:
25499 * @file: input #GFile.
25500 * @display_name: a string.
25501 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
25502 * @error: a #GError, or %NULL
25504 * Renames @file to the specified display name.
25505 * The display name is converted from UTF8 to the correct encoding for the target
25506 * filesystem if possible and the @file is renamed to this.
25507 * If you want to implement a rename operation in the user interface the edit name
25508 * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
25509 * widget, and then the result after editing should be passed to g_file_set_display_name().
25510 * On success the resulting converted filename is returned.
25511 * If @cancellable is not %NULL, then the operation can be cancelled by
25512 * triggering the cancellable object from another thread. If the operation
25513 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
25514 * if there was an error.
25515 * Free the returned object with g_object_unref().
25517 * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL
25522 * G_TYPE_DATE_TIME:
25524 * The #GType for a boxed type holding a #GDateTime.
25531 * g_settings_get_has_unapplied:
25532 * @settings: a #GSettings object
25533 * @returns: %TRUE if @settings has unapplied changes
25535 * Returns whether the #GSettings object has any unapplied
25536 * changes. This can only be the case if it is in 'delayed-apply' mode.
25543 * SECTION:gconverteroutputstrea:
25544 * @short_description: Converter Output Stream
25545 * @include: gio/gio.h
25546 * @see_also: #GOutputStream, #GConverter
25548 * Converter output stream implements #GOutputStream and allows
25549 * conversion of data of various types during reading.
25554 * g_file_poll_mountable_finish:
25555 * @file: input #GFile.
25556 * @result: a #GAsyncResult.
25557 * @error: a #GError, or %NULL
25559 * Finishes a poll operation. See g_file_poll_mountable() for details.
25560 * Finish an asynchronous poll operation that was polled
25561 * with g_file_poll_mountable().
25564 * Returns: %TRUE if the operation finished successfully. %FALSE
25570 * G_FILE_ATTRIBUTE_TRASH_ORIG_PATH:
25572 * A key in the "trash" namespace. When requested against
25573 * items in "trash:///", will return the original path to the file before it
25574 * was trashed. Corresponding #GFileAttributeType is
25575 * %G_FILE_ATTRIBUTE_TYPE_STRING.
25582 * g_io_error_quark:
25584 * Gets the GIO Error Quark.
25586 * Returns: a #GQuark.
25591 * g_network_service_get_domain:
25592 * @srv: a #GNetworkService
25594 * Gets the domain that @srv serves. This might be either UTF-8 or
25595 * ASCII-encoded, depending on what @srv was created with.
25597 * Returns: @srv's domain name
25603 * g_drive_get_name:
25604 * @drive: a #GDrive.
25606 * Gets the name of @drive.
25607 * string should be freed when no longer needed.
25609 * Returns: a string containing @drive's name. The returned
25614 * g_file_get_child_for_display_name:
25615 * @file: input #GFile.
25616 * @display_name: string to a possible child.
25619 * Gets the child of @file for a given @display_name (i.e. a UTF8
25620 * version of the name). If this function fails, it returns %NULL and @error will be
25621 * set. This is very useful when constructing a GFile for a new file
25622 * and the user entered the filename in the user interface, for instance
25623 * when you select a directory and type a filename in the file selector.
25624 * This call does no blocking i/o.
25625 * %NULL if the display name couldn't be converted.
25626 * Free the returned object with g_object_unref().
25628 * Returns: (transfer full): a #GFile to the specified child, or
25633 * g_file_info_set_modification_tim:
25634 * @info: a #GFileInfo.
25635 * @mtime: a #GTimeVal.
25637 * Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED attribute in the file
25638 * info to the given time value.
25643 * GCancellableSourceFunc:
25644 * @cancellable: the #GCancellable
25645 * @user_data: data passed in by the user.
25647 * This is the function type of the callback used for the #GSource
25648 * returned by g_cancellable_source_new().
25650 * Returns: it should return %FALSE if the source should be removed.
25656 * g_socket_get_protocol:
25657 * @socket: a #GSocket.
25659 * Gets the socket protocol id the socket was created with.
25660 * In case the protocol is unknown, -1 is returned.
25662 * Returns: a protocol id, or -1 if unknown
25668 * GPollableInputStream:
25670 * An interface for a #GInputStream that can be polled for readability.
25677 * g_file_query_info_async:
25678 * @file: input #GFile.
25679 * @attributes: an attribute query string.
25680 * @flags: a set of #GFileQueryInfoFlags.
25681 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
25682 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
25683 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
25684 * @user_data: (closure): the data to pass to callback function
25686 * Asynchronously gets the requested information about specified @file. The result
25687 * is a #GFileInfo object that contains key-value attributes (such as type or size
25689 * For more details, see g_file_query_info() which is
25690 * the synchronous version of this call.
25691 * When the operation is finished, @callback will be called. You can then call
25692 * g_file_query_info_finish() to get the result of the operation.
25697 * g_app_info_remove_supports_type:
25698 * @appinfo: a #GAppInfo.
25699 * @content_type: a string.
25700 * @error: a #GError.
25702 * Removes a supported type from an application, if possible.
25704 * Returns: %TRUE on success, %FALSE on error.
25709 * G_FLAGS_CLASS_TYPE_NAME:
25710 * @class: a #GFlagsClass
25712 * Get the static type name from a given #GFlagsClass structure.
25714 * Returns: the type name.
25720 * @object_type: a #GType supporting #GInitable.
25721 * @n_parameters: the number of parameters in @parameters
25722 * @parameters: the parameters to use to construct the object
25723 * @cancellable: optional #GCancellable object, %NULL to ignore.
25724 * @error: a #GError location to store the error occuring, or %NULL to ignore.
25726 * Helper function for constructing #GInitiable object. This is
25727 * similar to g_object_newv() but also initializes the object
25728 * and returns %NULL, setting an error on failure.
25730 * Returns: (transfer full): a newly allocated #GObject, or %NULL on error
25736 * GSocketConnectable:
25738 * Interface for objects that contain or generate #GSocketAddress<!-- -->es.
25743 * g_unix_output_stream_get_close_fd:
25744 * @stream: a #GUnixOutputStream
25746 * Returns whether the file descriptor of @stream will be
25747 * closed when the stream is closed.
25749 * Returns: %TRUE if the file descriptor is closed when done
25755 * g_settings_get_int:
25756 * @settings: a #GSettings object
25757 * @key: the key to get the value for
25758 * @returns: an integer
25760 * Gets the value that is stored at @key in @settings.
25761 * A convenience variant of g_settings_get() for 32-bit integers.
25762 * It is a programmer error to give a @key that isn't specified as
25763 * having a int32 type in the schema for @settings.
25770 * g_data_input_stream_set_newline_type:
25771 * @stream: a #GDataInputStream.
25772 * @type: the type of new line return as #GDataStreamNewlineType.
25774 * Sets the newline type for the @stream.
25775 * Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read
25776 * chunk ends in "CR" we must read an additional byte to know if this is "CR" or
25777 * "CR LF", and this might block if there is no more data availible.
25782 * g_inet_socket_address_new:
25783 * @address: a #GInetAddress
25784 * @port: a port number
25786 * Creates a new #GInetSocketAddress for @address and @port.
25788 * Returns: a new #GInetSocketAddress
25794 * g_dbus_connection_new_for_address_finish:
25795 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
25796 * @error: Return location for error or %NULL.
25798 * Finishes an operation started with g_dbus_connection_new_for_address().
25800 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
25806 * g_srv_target_get_weight:
25807 * @target: a #GSrvTarget
25809 * Gets @target's weight. You should not need to look at this;
25810 * #GResolver already sorts the targets according to the algorithm in
25813 * Returns: @target's weight
25819 * G_FILE_ATTRIBUTE_ACCESS_CAN_READ:
25821 * A key in the "access" namespace for getting read privileges.
25822 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
25823 * This attribute will be %TRUE if the user is able to read the file.
25828 * g_application_command_line_get_cwd:
25829 * @cmdline: a #GApplicationCommandLine
25831 * Gets the working directory of the command line invocation. The
25832 * string may contain non-utf8 data.
25833 * It is possible that the remote application did not send a working
25834 * directory, so this may be %NULL.
25835 * The return value should not be modified or freed and is valid for as
25836 * long as @cmdline exists.
25838 * Returns: the current directory, or %NULL
25844 * g_mount_operation_set_password:
25845 * @op: a #GMountOperation.
25846 * @password: password to set.
25848 * Sets the mount operation's password to @password.
25853 * GUnixSocketAddressType:
25854 * @G_UNIX_SOCKET_ADDRESS_INVALID: invalid
25855 * @G_UNIX_SOCKET_ADDRESS_ANONYMOUS: anonymous
25856 * @G_UNIX_SOCKET_ADDRESS_PATH: a filesystem path
25857 * @G_UNIX_SOCKET_ADDRESS_ABSTRACT: an abstract name
25858 * @G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED: an abstract name, 0-padded to the full length of a unix socket name
25860 * The type of name used by a #GUnixSocketAddress.
25861 * %G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain
25862 * socket bound to a filesystem path. %G_UNIX_SOCKET_ADDRESS_ANONYMOUS
25863 * indicates a socket not bound to any name (eg, a client-side socket,
25864 * or a socket created with socketpair()).
25865 * For abstract sockets, there are two incompatible ways of naming
25866 * sockaddr_un</literal> as the name, padding the unused parts of the
25867 * %sun_path field with zeroes; this corresponds to
25868 * %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED. However, many programs
25869 * instead just use a portion of %sun_path, and pass an appropriate
25870 * smaller length to bind() or connect(). This is
25871 * %G_UNIX_SOCKET_ADDRESS_ABSTRACT.
25873 * Them: the man pages suggest using the entire <literal>struct
25880 * @object_type: a #GType supporting #GInitable.
25881 * @cancellable: optional #GCancellable object, %NULL to ignore.
25882 * @error: a #GError location to store the error occuring, or %NULL to ignore.
25883 * @first_property_name: the name of the first property, or %NULL if no properties
25884 * @...: the value if the first property, followed by and other property value pairs, and ended by %NULL.
25886 * Helper function for constructing #GInitiable object. This is
25887 * similar to g_object_new() but also initializes the object
25888 * and returns %NULL, setting an error on failure.
25890 * Returns: (transfer full): a newly allocated #GObject, or %NULL on error
25896 * g_file_info_set_attribute_uint32:
25897 * @info: a #GFileInfo.
25898 * @attribute: a file attribute key.
25899 * @attr_value: an unsigned 32-bit integer.
25901 * Sets the @attribute to contain the given @attr_value,
25907 * g_volume_get_name:
25908 * @volume: a #GVolume.
25910 * Gets the name of @volume.
25911 * be freed with g_free() when no longer needed.
25913 * Returns: the name for the given @volume. The returned string should
25918 * g_converter_input_stream_new:
25919 * @base_stream: a #GInputStream
25920 * @converter: a #GConverter
25922 * Creates a new converter input stream for the @base_stream.
25924 * Returns: a new #GInputStream.
25930 * @short_description: Low-level socket object
25931 * @include: gio/gio.h
25932 * @see_also: #GInitable
25934 * A #GSocket is a low-level networking primitive. It is a more or less
25935 * direct mapping of the BSD socket API in a portable GObject based API.
25936 * It supports both the UNIX socket implementations and winsock2 on Windows.
25937 * #GSocket is the platform independent base upon which the higher level
25938 * network primitives are based. Applications are not typically meant to
25939 * use it directly, but rather through classes like #GSocketClient,
25940 * #GSocketService and #GSocketConnection. However there may be cases where
25941 * direct use of #GSocket is useful.
25942 * #GSocket implements the #GInitable interface, so if it is manually constructed
25943 * by e.g. g_object_new() you must call g_initable_init() and check the
25944 * results before using the object. This is done automatically in
25945 * g_socket_new() and g_socket_new_from_fd(), so these functions can return
25947 * Sockets operate in two general modes, blocking or non-blocking. When
25948 * in blocking mode all operations block until the requested operation
25949 * is finished or there is an error. In non-blocking mode all calls that
25950 * would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error.
25951 * To know when a call would successfully run you can call g_socket_condition_check(),
25952 * or g_socket_condition_wait(). You can also use g_socket_create_source() and
25953 * attach it to a #GMainContext to get callbacks when I/O is possible.
25954 * Note that all sockets are always set to non blocking mode in the system, and
25955 * blocking mode is emulated in GSocket.
25956 * When working in non-blocking mode applications should always be able to
25957 * handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other
25958 * function said that I/O was possible. This can easily happen in case
25959 * of a race condition in the application, but it can also happen for other
25960 * reasons. For instance, on Windows a socket is always seen as writable
25961 * until a write returns %G_IO_ERROR_WOULD_BLOCK.
25962 * #GSocket<!-- -->s can be either connection oriented or datagram based.
25963 * For connection oriented types you must first establish a connection by
25964 * either connecting to an address or accepting a connection from another
25965 * address. For connectionless socket types the target/source address is
25966 * specified or received in each I/O operation.
25967 * All socket file descriptors are set to be close-on-exec.
25968 * Note that creating a #GSocket causes the signal %SIGPIPE to be
25969 * ignored for the remainder of the program. If you are writing a
25970 * command-line utility that uses #GSocket, you may need to take into
25971 * account the fact that your program will not automatically be killed
25972 * if it tries to write to %stdout after it has been closed.
25981 * The file containing the icon.
25986 * g_emblem_new_with_origin:
25987 * @icon: a GIcon containing the icon.
25988 * @origin: a GEmblemOrigin enum defining the emblem's origin
25990 * Creates a new emblem for @icon.
25992 * Returns: a new #GEmblem.
25998 * GDBusServer:client-address:
26000 * The D-Bus address that clients can use.
26008 * @g_type_class: the parent class
26009 * @minimum: the smallest possible value.
26010 * @maximum: the largest possible value.
26011 * @n_values: the number of possible values.
26012 * @values: an array of #GEnumValue structs describing the individual values.
26014 * The class of an enumeration type holds information about its
26020 * g_file_output_stream_get_etag:
26021 * @stream: a #GFileOutputStream.
26023 * Gets the entity tag for the file when it has been written.
26024 * This must be called after the stream has been written
26025 * and closed, as the etag can change while writing.
26027 * Returns: the entity tag for the stream.
26032 * G_TYPE_FUNDAMENTAL_MAX:
26034 * An integer constant that represents the number of identifiers reserved
26035 * for types that are assigned at compile-time.
26041 * @boxed: The boxed structure to be copied.
26043 * This function is provided by the user and should produce a copy of the passed
26044 * in boxed structure.
26046 * Returns: The newly created copy of the boxed structure.
26052 * @parent_instance: private #GParamSpec portion
26053 * @minimum: minimum value for the property specified
26054 * @maximum: maximum value for the property specified
26055 * @default_value: default value for the property specified
26057 * A #GParamSpec derived structure that contains the meta data for long integer properties.
26062 * g_tls_certificate_new_from_files:
26063 * @cert_file: file containing a PEM-encoded certificate to import
26064 * @key_file: file containing a PEM-encoded private key to import
26065 * @error: #GError for error reporting, or %NULL to ignore.
26067 * Creates a #GTlsCertificate from the PEM-encoded data in @cert_file
26068 * and @key_file. If either file cannot be read or parsed, the
26069 * function will return %NULL and set @error. Otherwise, this behaves
26070 * like g_tls_certificate_new().
26072 * Returns: the new certificate, or %NULL on error
26078 * GMemoryOutputStream:data-size:
26080 * Size of data written to the buffer.
26089 * The fundamental type corresponding to #gboolean.
26094 * GDBusConnection:stream:
26096 * The underlying #GIOStream used for I/O.
26104 * @G_OPTION_ERROR_UNKNOWN_OPTION: 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().
26105 * @G_OPTION_ERROR_BAD_VALUE: A value couldn't be parsed.
26106 * @G_OPTION_ERROR_FAILED: A #GOptionArgFunc callback failed.
26108 * Error codes returned by option parsing.
26113 * g_output_stream_set_pending:
26114 * @stream: a #GOutputStream.
26115 * @error: a #GError location to store the error occuring, or %NULL to ignore.
26117 * Sets @stream to have actions pending. If the pending flag is
26118 * already set or @stream is closed, it will return %FALSE and set
26120 * Returns: %TRUE if pending was previously unset and is now set.
26125 * SECTION:gconverterinputstrea:
26126 * @short_description: Converter Input Stream
26127 * @include: gio/gio.h
26128 * @see_also: #GInputStream, #GConverter
26130 * Converter input stream implements #GInputStream and allows
26131 * conversion of data of various types during reading.
26136 * g_input_stream_skip:
26137 * @stream: a #GInputStream.
26138 * @count: the number of bytes that will be skipped from the stream
26139 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
26140 * @error: location to store the error occuring, or %NULL to ignore
26142 * Tries to skip @count bytes from the stream. Will block during the operation.
26143 * This is identical to g_input_stream_read(), from a behaviour standpoint,
26144 * but the bytes that are skipped are not returned to the user. Some
26145 * streams have an implementation that is more efficient than reading the data.
26146 * This function is optional for inherited classes, as the default implementation
26147 * emulates it using read.
26148 * If @cancellable is not %NULL, then the operation can be cancelled by
26149 * triggering the cancellable object from another thread. If the operation
26150 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
26151 * operation was partially finished when the operation was cancelled the
26152 * partial result will be returned, without an error.
26154 * Returns: Number of bytes skipped, or -1 on error
26159 * g_mount_operation_set_password_save:
26160 * @op: a #GMountOperation.
26161 * @save: a set of #GPasswordSave flags.
26163 * Sets the state of saving passwords for the mount operation.
26168 * g_app_info_launch_default_for_uri:
26169 * @uri: the uri to show
26170 * @launch_context: (allow-none): an optional #GAppLaunchContext.
26171 * @error: a #GError.
26173 * Utility function that launches the default application
26174 * registered to handle the specified uri. Synchronous I/O
26175 * is done on the uri to detect the type of the file if
26178 * Returns: %TRUE on success, %FALSE on error.
26183 * G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME:
26185 * A key in the "standard" namespace for edit name of the file.
26186 * An edit name is similar to the display name, but it is meant to be
26187 * used when you want to rename the file in the UI. The display name
26188 * might contain information you don't want in the new filename (such as
26189 * "(invalid unicode)" if the filename was in an invalid encoding).
26190 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
26195 * GZlibCompressorFormat:
26196 * @G_ZLIB_COMPRESSOR_FORMAT_ZLIB: deflate compression with zlib header
26197 * @G_ZLIB_COMPRESSOR_FORMAT_GZIP: gzip file format
26198 * @G_ZLIB_COMPRESSOR_FORMAT_RAW: deflate compression with no header
26200 * Used to select the type of data format to use for #GZlibDecompressor
26201 * and #GZlibCompressor.
26208 * G_TYPE_PARAM_VALUE_ARRAY:
26210 * The #GType of #GParamSpecValueArray.
26215 * g_buffered_input_stream_fill_finish:
26216 * @stream: a #GBufferedInputStream
26217 * @result: a #GAsyncResult
26218 * @error: a #GError
26220 * Finishes an asynchronous read.
26222 * Returns: a #gssize of the read stream, or %-1 on an error.
26227 * G_DEFINE_INTERFACE_WITH_CODE:
26228 * @TN: The name of the new type, in Camel case.
26229 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
26230 * @T_P: The #GType of the prerequisite type for the interface, or 0 (%G_TYPE_INVALID) for no prerequisite type.
26231 * @_C_: Custom code that gets inserted in the *_get_type() function.
26233 * A convenience macro for #GTypeInterface definitions. Similar to
26234 * G_DEFINE_INTERFACE(), but allows you to insert custom code into the
26235 * *_get_type() function, e.g. additional interface implementations
26236 * via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. See
26237 * G_DEFINE_TYPE_EXTENDED() for a similar example using
26238 * G_DEFINE_TYPE_WITH_CODE().
26245 * g_file_info_set_name:
26246 * @info: a #GFileInfo.
26247 * @name: a string containing a name.
26249 * Sets the name attribute for the current #GFileInfo.
26250 * See %G_FILE_ATTRIBUTE_STANDARD_NAME.
26257 * The <structname>GMainContext</structname> struct is an opaque data
26258 * type representing a set of sources to be handled in a main loop.
26263 * g_socket_address_new_from_native:
26264 * @native: a pointer to a <type>struct sockaddr</type>
26265 * @len: the size of the memory location pointed to by @native
26267 * Creates a #GSocketAddress subclass corresponding to the native
26268 * <type>struct sockaddr</type> @native.
26271 * Returns: a new #GSocketAddress if @native could successfully be converted,
26278 * @G_RESOLVER_ERROR_NOT_FOUND: the requested name/address/service was not found
26279 * @G_RESOLVER_ERROR_TEMPORARY_FAILURE: the requested information could not be looked up due to a network error or similar problem
26280 * @G_RESOLVER_ERROR_INTERNAL: unknown error
26282 * An error code used with %G_RESOLVER_ERROR in a #GError returned
26283 * from a #GResolver routine.
26290 * g_drive_start_finish:
26291 * @drive: a #GDrive.
26292 * @result: a #GAsyncResult.
26293 * @error: a #GError, or %NULL
26295 * Finishes starting a drive.
26296 * %FALSE otherwise.
26298 * Returns: %TRUE if the drive has been started successfully,
26305 * @G_TYPE_DEBUG_NONE: Print no messages.
26306 * @G_TYPE_DEBUG_OBJECTS: Print messages about object bookkeeping.
26307 * @G_TYPE_DEBUG_SIGNALS: Print messages about signal emissions.
26308 * @G_TYPE_DEBUG_MASK: Mask covering all debug flags.
26310 * The <type>GTypeDebugFlags</type> enumeration values can be passed to
26311 * g_type_init_with_debug_flags() to trigger debugging messages during runtime.
26312 * Note that the messages can also be triggered by setting the
26313 * <envar>GOBJECT_DEBUG</envar> environment variable to a ':'-separated list of
26314 * "objects" and "signals".
26319 * g_settings_range_check:
26320 * @settings: a #GSettings
26321 * @key: the key to check
26322 * @value: the value to check
26323 * @returns: %TRUE if @value is valid for @key
26325 * Checks if the given @value is of the correct type and within the
26326 * permitted range for @key.
26327 * This API is not intended to be used by normal programs -- they should
26328 * already know what is permitted by their own schemas. This API is
26329 * meant to be used by programs such as editors or commandline tools.
26330 * It is a programmer error to give a @key that isn't contained in the
26331 * schema for @settings.
26338 * g_socket_set_keepalive:
26339 * @socket: a #GSocket.
26340 * @keepalive: Value for the keepalive flag
26342 * Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When
26343 * this flag is set on a socket, the system will attempt to verify that the
26344 * remote socket endpoint is still present if a sufficiently long period of
26345 * time passes with no data being exchanged. If the system is unable to
26346 * verify the presence of the remote endpoint, it will automatically close
26348 * This option is only functional on certain kinds of sockets. (Notably,
26349 * %G_SOCKET_PROTOCOL_TCP sockets.)
26350 * The exact time between pings is system- and protocol-dependent, but will
26351 * normally be at least two hours. Most commonly, you would set this flag
26352 * on a server socket if you want to allow clients to remain idle for long
26353 * periods of time, but also want to ensure that connections are eventually
26354 * garbage-collected if clients crash or become unreachable.
26362 * @short_description: Interface for proxy handling
26364 * A #GProxy handles connecting to a remote host via a given type of
26365 * proxy server. It is implemented by the 'gio-proxy' extension point.
26366 * The extensions are named after their proxy protocol name. As an
26367 * example, a SOCKS5 proxy implementation can be retrieved with the
26368 * name 'socks5' using the function
26369 * g_io_extension_point_get_extension_by_name().
26376 * G_IS_PARAM_SPEC_STRING:
26377 * @pspec: a valid #GParamSpec instance
26379 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING.
26381 * Returns: %TRUE on success.
26386 * g_unix_fd_message_steal_fds:
26387 * @message: a #GUnixFDMessage
26388 * @length: (out) (allow-none): pointer to the length of the returned array, or %NULL
26390 * Returns the array of file descriptors that is contained in this
26392 * After this call, the descriptors are no longer contained in
26393 * descriptors have been added).
26394 * The return result of this function must be freed with g_free().
26395 * The caller is also responsible for closing all of the file
26397 * If @length is non-%NULL then it is set to the number of file
26398 * descriptors in the returned array. The returned array is also
26399 * terminated with -1.
26400 * This function never returns %NULL. In case there are no file
26401 * descriptors contained in @message, an empty array is returned.
26404 * Returns: (array length=length) (transfer full): an array of file
26412 * The fundamental type corresponding to #gpointer.
26417 * G_VOLUME_IDENTIFIER_KIND_UUID:
26419 * The string used to obtain a UUID with g_volume_get_identifier().
26424 * G_VARIANT_TYPE_UNIT:
26426 * The empty tuple type. Has only one instance. Known also as "triv"
26432 * g_file_enumerator_next_file:
26433 * @enumerator: a #GFileEnumerator.
26434 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
26435 * @error: location to store the error occuring, or %NULL to ignore
26437 * Returns information for the next file in the enumerated object.
26438 * Will block until the information is available. The #GFileInfo
26439 * returned from this function will contain attributes that match the
26440 * attribute string that was passed when the #GFileEnumerator was created.
26441 * On error, returns %NULL and sets @error to the error. If the
26442 * enumerator is at the end, %NULL will be returned and @error will
26444 * Free the returned object with g_object_unref() when no longer needed.
26446 * Returns: (transfer full): A #GFileInfo or %NULL on error or end of enumerator.
26451 * g_unix_fd_list_get_length:
26452 * @list: a #GUnixFDList
26454 * contained within).
26456 * Gets the length of @list (ie: the number of file descriptors
26457 * Returns: the length of @list
26463 * GTypePluginClass:
26464 * @use_plugin: Increases the use count of the plugin.
26465 * @unuse_plugin: Decreases the use count of the plugin.
26466 * @complete_type_info: Fills in the #GTypeInfo and #GTypeValueTable structs for the type. The structs are initialized with <literal>memset(s, 0, sizeof (s))</literal> before calling this function.
26467 * @complete_interface_info: Fills in missing parts of the #GInterfaceInfo for the interface. The structs is initialized with <literal>memset(s, 0, sizeof (s))</literal> before calling this function.
26469 * The #GTypePlugin interface is used by the type system in order to handle
26470 * the lifecycle of dynamically loaded types.
26475 * GDBusServerClass:
26476 * @new_connection: Signal class handler for the #GDBusServer::new-connection signal.
26478 * Class structure for #GDBusServer.
26485 * g_socket_speaks_ipv4:
26486 * @socket: a #GSocket
26488 * Checks if a socket is capable of speaking IPv4.
26489 * IPv4 sockets are capable of speaking IPv4. On some operating systems
26490 * and under some combinations of circumstances IPv6 sockets are also
26491 * capable of speaking IPv4. See RFC 3493 section 3.7 for more
26493 * No other types of sockets are currently considered as being capable
26494 * of speaking IPv4.
26496 * Returns: %TRUE if this socket can be used with IPv4.
26502 * g_dbus_message_set_message_type:
26503 * @message: A #GDBusMessage.
26504 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
26506 * Sets @message to be of @type.
26515 * The type for #GType.
26521 * @type_string: a well-formed #GVariantType type string
26523 * Converts a string to a const #GVariantType. Depending on the
26524 * current debugging level, this function may perform a runtime check
26525 * to ensure that @string is a valid GVariant type string.
26526 * It is always a programmer error to use this macro with an invalid
26535 * The #GType for a boxed type holding a #GRegex reference.
26544 * If @action is currently enabled.
26545 * If the action is disabled then calls to g_action_activate() and
26546 * g_action_set_state() have no effect.
26555 * The fundamental type corresponding to #gint64.
26560 * G_TIME_SPAN_MILLISECOND:
26562 * Evaluates to a time span of one millisecond.
26571 * The name of the action. This is mostly meaningful for identifying
26572 * the action once it has been added to a #GActionGroup.
26579 * g_io_stream_splice_async:
26580 * @stream1: a #GIOStream.
26581 * @stream2: a #GIOStream.
26582 * @flags: a set of #GIOStreamSpliceFlags.
26583 * @io_priority: the io priority of the request.
26584 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
26585 * @callback: (scope async): a #GAsyncReadyCallback.
26586 * @user_data: (closure): user data passed to @callback.
26588 * Asyncronously splice the output stream of @stream1 to the input stream of
26589 * When the operation is finished @callback will be called.
26590 * You can then call g_io_stream_splice_finish() to get the
26591 * result of the operation.
26598 * g_unix_mount_guess_should_display:
26599 * @mount_entry: a #GUnixMountEntry
26601 * Guesses whether a Unix mount should be displayed in the UI.
26603 * Returns: %TRUE if @mount_entry is deemed to be displayable.
26608 * g_volume_monitor_get_mount_for_uuid:
26609 * @volume_monitor: a #GVolumeMonitor.
26610 * @uuid: the UUID to look for
26612 * Finds a #GMount object by its UUID (see g_mount_get_uuid())
26613 * Free the returned object with g_object_unref().
26615 * Returns: (transfer full): a #GMount or %NULL if no such mount is available.
26620 * G_VALUE_HOLDS_INT64:
26621 * @value: a valid #GValue structure
26623 * Checks whether the given #GValue can hold values of type %G_TYPE_INT64.
26625 * Returns: %TRUE on success.
26630 * GFileMonitor::changed:
26631 * @monitor: a #GFileMonitor.
26633 * @other_file: a #GFile or #NULL.
26634 * @event_type: a #GFileMonitorEvent.
26636 * Emitted when @file has been changed.
26637 * If using #G_FILE_MONITOR_SEND_MOVED flag and @event_type is
26638 * #G_FILE_MONITOR_SEND_MOVED, @file will be set to a #GFile containing the
26639 * old path, and @other_file will be set to a #GFile containing the new path.
26640 * In all the other cases, @other_file will be set to #NULL.
26645 * G_IS_PARAM_SPEC_FLAGS:
26646 * @pspec: a valid #GParamSpec instance
26648 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS.
26650 * Returns: %TRUE on success.
26655 * g_file_create_readwrite_finish:
26656 * @file: input #GFile
26657 * @res: a #GAsyncResult
26658 * @error: a #GError, or %NULL
26660 * Finishes an asynchronous file create operation started with
26661 * g_file_create_readwrite_async().
26662 * Free the returned object with g_object_unref().
26664 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
26670 * g_converter_output_stream_get_converter:
26671 * @converter_stream: a #GConverterOutputStream
26673 * Gets the #GConverter that is used by @converter_stream.
26675 * Returns: (transfer none): the converter of the converter output stream
26681 * G_DEFINE_POINTER_TYPE_WITH_CODE:
26682 * @TypeName: The name of the new type, in Camel case.
26683 * @type_name: The name of the new type, in lowercase, with words separated by '_'.
26684 * @_C_: Custom code that gets inserted in the *_get_type() function.
26686 * A convenience macro for pointer type implementations.
26687 * Similar to G_DEFINE_POINTER_TYPE(), but allows to insert custom code into the
26688 * type_name_get_type() function.
26695 * g_file_monitor_set_rate_limit:
26696 * @monitor: a #GFileMonitor.
26697 * @limit_msecs: a non-negative integer with the limit in milliseconds to poll for changes
26699 * Sets the rate limit to which the @monitor will report
26700 * consecutive change events to the same file.
26705 * g_cancellable_set_error_if_cancelled:
26706 * @cancellable: a #GCancellable object.
26707 * @error: #GError to append error state to.
26709 * If the @cancellable is cancelled, sets the error to notify
26710 * that the operation was cancelled.
26712 * Returns: %TRUE if @cancellable was cancelled, %FALSE if it was not.
26717 * g_file_create_finish:
26718 * @file: input #GFile.
26719 * @res: a #GAsyncResult.
26720 * @error: a #GError, or %NULL
26722 * Finishes an asynchronous file create operation started with
26723 * g_file_create_async().
26724 * Free the returned object with g_object_unref().
26726 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
26731 * g_tls_connection_set_use_system_certdb:
26732 * @conn: a #GTlsConnection
26733 * @use_system_certdb: whether to use the system certificate database
26735 * Sets whether @conn uses the system certificate database to verify
26736 * peer certificates. This is %TRUE by default. If set to %FALSE, then
26737 * peer certificate validation will always set the
26738 * %G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning
26739 * #GTlsConnection::accept-certificate will always be emitted on
26740 * client-side connections, unless that bit is not set in
26741 * #GTlsClientConnection:validation-flags).
26748 * g_mount_operation_get_password_save:
26749 * @op: a #GMountOperation.
26751 * Gets the state of saving passwords for the mount operation.
26753 * Returns: a #GPasswordSave flag.
26758 * G_PROXY_EXTENSION_POINT_NAME:
26760 * Extension point for proxy functionality.
26761 * See <link linkend="extending-gio">Extending GIO</link>.
26768 * g_tls_client_connection_get_validation_flags:
26769 * @conn: the #GTlsClientConnection
26771 * Gets @conn's validation flags
26773 * Returns: the validation flags
26779 * SECTION:gzcompresso:
26780 * @short_description: Zlib compressor
26781 * @include: gio/gio.h
26783 * #GZlibCompressor is an implementation of #GConverter that
26784 * compresses data using zlib.
26789 * g_buffered_input_stream_new:
26790 * @base_stream: a #GInputStream
26792 * Creates a new #GInputStream from the given @base_stream, with
26793 * a buffer set to the default size (4 kilobytes).
26795 * Returns: a #GInputStream for the given @base_stream.
26800 * G_PARAM_SPEC_UINT:
26801 * @pspec: a valid #GParamSpec instance
26803 * Cast a #GParamSpec instance into a #GParamSpecUInt.
26809 * @G_PARAM_READABLE: the parameter is readable
26810 * @G_PARAM_WRITABLE: the parameter is writable
26811 * @G_PARAM_CONSTRUCT: the parameter will be set upon object construction
26812 * @G_PARAM_CONSTRUCT_ONLY: the parameter will only be set upon object construction
26813 * @G_PARAM_LAX_VALIDATION: upon parameter conversion (see g_param_value_convert()) strict validation is not required
26814 * @G_PARAM_STATIC_NAME: 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
26815 * @G_PARAM_STATIC_NICK: 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
26816 * @G_PARAM_STATIC_BLURB: 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
26817 * @G_PARAM_PRIVATE: internal
26818 * @G_PARAM_DEPRECATED: 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
26820 * Through the #GParamFlags flag values, certain aspects of parameters
26821 * can be configured.
26826 * g_unix_connection_send_credentials:
26827 * @connection: A #GUnixConnection.
26828 * @cancellable: (allow-none): A #GCancellable or %NULL.
26829 * @error: Return location for error or %NULL.
26831 * Passes the credentials of the current user the receiving side
26832 * of the connection. The recieving end has to call
26833 * g_unix_connection_receive_credentials() (or similar) to accept the
26835 * As well as sending the credentials this also writes a single NUL
26836 * byte to the stream, as this is required for credentials passing to
26837 * work on some implementations.
26838 * Other ways to exchange credentials with a foreign peer includes the
26839 * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
26841 * Returns: %TRUE on success, %FALSE if @error is set.
26847 * G_IS_PARAM_SPEC_VARIANT:
26848 * @pspec: a #GParamSpec
26850 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VARIANT.
26852 * Returns: %TRUE on success
26858 * g_tls_error_quark:
26860 * Gets the TLS error quark.
26862 * Returns: a #GQuark.
26868 * g_settings_backend_changed:
26869 * @backend: a #GSettingsBackend implementation
26870 * @key: the name of the key
26871 * @origin_tag: the origin tag
26873 * Signals that a single key has possibly changed. Backend
26874 * implementations should call this if a key has possibly changed its
26876 * '//', and not ending with a slash).
26877 * The implementation must call this function during any call to
26878 * g_settings_backend_write(), before the call returns (except in the
26879 * case that no keys are actually changed and it cares to detect this
26880 * fact). It may not rely on the existence of a mainloop for
26881 * dispatching the signal later.
26882 * The implementation may call this function at any other time it likes
26883 * in response to other events (such as changes occuring outside of the
26884 * program). These calls may originate from a mainloop or may originate
26885 * in response to any other action (including from calls to
26886 * g_settings_backend_write()).
26887 * In the case that this call is in response to a call to
26888 * g_settings_backend_write() then @origin_tag must be set to the same
26889 * value that was passed to that call.
26896 * g_data_input_stream_read_line_finish:
26897 * @stream: a given #GDataInputStream.
26898 * @result: the #GAsyncResult that was provided to the callback.
26899 * @length: (out): a #gsize to get the length of the data read in.
26900 * @error: #GError for error reporting.
26902 * Finish an asynchronous call started by
26903 * g_data_input_stream_read_line_async().
26904 * (without the newlines). Set @length to a #gsize to get the
26905 * length of the read line. On an error, it will return %NULL and
26906 * still return %NULL, but @error won't be set.
26908 * Returns: (transfer full): a string with the line that was read in
26914 * g_content_type_get_icon:
26915 * @type: a content type string
26917 * Gets the icon for a content type.
26918 * object with g_object_unref()
26920 * Returns: (transfer full): #GIcon corresponding to the content type. Free the returned
26925 * G_TYPE_IO_CHANNEL:
26927 * The #GType for #GIOChannel.
26932 * g_tls_connection_handshake_finish:
26933 * @conn: a #GTlsConnection
26934 * @result: a #GAsyncResult.
26935 * @error: a #GError pointer, or %NULL
26937 * Finish an asynchronous TLS handshake operation. See
26938 * g_tls_connection_handshake() for more information.
26939 * case @error will be set.
26941 * Returns: %TRUE on success, %FALSE on failure, in which
26947 * GInetAddress:is-mc-node-local:
26949 * Whether this is a node-local multicast address.
26950 * See g_inet_address_get_is_mc_node_local().
26957 * GInetAddress:is-site-local:
26959 * Whether this is a site-local address.
26960 * See g_inet_address_get_is_loopback().
26967 * G_OPTION_REMAINING:
26969 * If a long option in the main group has this name, it is not treated as a
26970 * regular option. Instead it collects all non-option arguments which would
26971 * otherwise be left in <literal>argv</literal>. The option must be of type
26972 * %G_OPTION_ARG_CALLBACK, %G_OPTION_ARG_STRING_ARRAY
26973 * or %G_OPTION_ARG_FILENAME_ARRAY.
26974 * Using #G_OPTION_REMAINING instead of simply scanning <literal>argv</literal>
26975 * for leftover arguments has the advantage that GOption takes care of
26976 * necessary encoding conversions for strings or filenames.
26983 * G_OBJECT_TYPE_NAME:
26984 * @object: Object to return the type name for.
26986 * Get the name of an object's type.
26987 * should not be freed.
26989 * Returns: Type name of @object. The string is owned by the type system and
26994 * g_io_scheduler_cancel_all_jobs:
26996 * Cancels all cancellable I/O jobs.
26997 * A job is cancellable if a #GCancellable was passed into
26998 * g_io_scheduler_push_job().
27003 * g_unix_fd_list_new:
27005 * Creates a new #GUnixFDList containing no file descriptors.
27007 * Returns: a new #GUnixFDList
27013 * g_network_address_get_hostname:
27014 * @addr: a #GNetworkAddress
27016 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
27017 * depending on what @addr was created with.
27019 * Returns: @addr's hostname
27025 * G_TYPE_PARAM_LONG:
27027 * The #GType of #GParamSpecLong.
27034 * Base class for writing output.
27035 * All classes derived from GOutputStream should implement synchronous
27036 * writing, splicing, flushing and closing streams, but may implement
27037 * asynchronous versions.
27042 * GFileOutputStream:
27044 * A subclass of GOutputStream for opened files. This adds
27045 * a few file-specific operations and seeking and truncating.
27046 * #GFileOutputStream implements GSeekable.
27051 * SECTION:ginetsocketaddres:
27052 * @short_description: Internet GSocketAddress
27054 * An IPv4 or IPv6 socket address; that is, the combination of a
27055 * #GInetAddress and a port number.
27061 * @ref_count: The reference count or -1 if statically allocated.
27062 * @name: Name of the argument, e.g. @unix_user_id.
27063 * @signature: D-Bus signature of the argument (a single complete type).
27064 * @annotations: A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
27066 * Information about an argument for a method or a signal.
27073 * GDrive::stop-button:
27074 * @drive: a #GDrive.
27076 * Emitted when the physical stop button (if any) of a drive has
27084 * SECTION:gsimplepermissio:
27085 * @title: GSimplePermission
27086 * @short_description: A GPermission that doesn't change value
27088 * #GSimplePermission is a trivial implementation of #GPermission that
27089 * represents a permission that is either always or never allowed. The
27090 * value is given at constuction and doesn't change.
27091 * Calling request or release will result in errors.
27096 * g_bus_get_finish:
27097 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
27098 * @error: Return location for error or %NULL.
27100 * Finishes an operation started with g_bus_get().
27101 * The returned object is a singleton, that is, shared with other
27102 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
27103 * event that you need a private message bus connection, use
27104 * g_dbus_address_get_for_bus() and
27105 * g_dbus_connection_new_for_address().
27106 * Note that the returned #GDBusConnection object will (usually) have
27107 * the #GDBusConnection:exit-on-close property set to %TRUE.
27109 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
27115 * g_action_group_get_action_state_hint:
27116 * @action_group: a #GActionGroup
27117 * @action_name: the name of the action to query
27119 * Requests a hint about the valid range of values for the state of the
27120 * named action within @action_group.
27121 * If %NULL is returned it either means that the action is not stateful
27122 * or that there is no hint about the valid range of values for the
27123 * state of the action.
27124 * If a #GVariant array is returned then each item in the array is a
27125 * returned then the tuple specifies the inclusive lower and upper bound
27126 * of valid values for the state.
27127 * In any case, the information is merely a hint. It may be possible to
27128 * have a state value outside of the hinted range and setting a value
27129 * within the range may fail.
27130 * The return value (if non-%NULL) should be freed with
27131 * g_variant_unref() when it is no longer required.
27133 * Possible value for the state. if a #gvariant pair (ie: two-tuple) is
27134 * Returns: (transfer full): the state range hint
27140 * g_app_info_get_name:
27141 * @appinfo: a #GAppInfo.
27143 * Gets the installed name of the application.
27145 * Returns: the name of the application for @appinfo.
27150 * G_TYPE_HAS_VALUE_TABLE:
27151 * @type: A #GType value.
27153 * Checks if @type has a #GTypeValueTable.
27155 * Returns: %TRUE on success.
27160 * GFileAttributeType:
27161 * @G_FILE_ATTRIBUTE_TYPE_INVALID: indicates an invalid or uninitalized type.
27162 * @G_FILE_ATTRIBUTE_TYPE_STRING: a null terminated UTF8 string.
27163 * @G_FILE_ATTRIBUTE_TYPE_BYTE_STRING: a zero terminated string of non-zero bytes.
27164 * @G_FILE_ATTRIBUTE_TYPE_BOOLEAN: a boolean value.
27165 * @G_FILE_ATTRIBUTE_TYPE_UINT32: an unsigned 4-byte/32-bit integer.
27166 * @G_FILE_ATTRIBUTE_TYPE_INT32: a signed 4-byte/32-bit integer.
27167 * @G_FILE_ATTRIBUTE_TYPE_UINT64: an unsigned 8-byte/64-bit integer.
27168 * @G_FILE_ATTRIBUTE_TYPE_INT64: a signed 8-byte/64-bit integer.
27169 * @G_FILE_ATTRIBUTE_TYPE_OBJECT: a #GObject.
27170 * @G_FILE_ATTRIBUTE_TYPE_STRINGV: a %NULL terminated char **. Since 2.22
27172 * The data types for file attributes.
27177 * g_file_info_set_attribute_status:
27178 * @info: a #GFileInfo
27179 * @attribute: a file attribute key
27180 * @status: a #GFileAttributeStatus
27182 * Sets the attribute status for an attribute key. This is only
27183 * needed by external code that implement g_file_set_attributes_from_info()
27184 * or similar functions.
27185 * The attribute must exist in @info for this to work. Otherwise %FALSE
27186 * is returned and @info is unchanged.
27188 * Returns: %TRUE if the status was changed, %FALSE if the key was not set.
27194 * g_file_info_get_etag:
27195 * @info: a #GFileInfo.
27197 * Gets the <link linkend="gfile-etag">entity tag</link> for a given
27198 * #GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE.
27200 * Returns: a string containing the value of the "etag:value" attribute.
27205 * G_TYPE_DBUS_METHOD_INFO:
27207 * The #GType for a boxed type holding a #GDBusMethodInfo.
27214 * g_app_info_get_icon:
27215 * @appinfo: a #GAppInfo.
27217 * Gets the icon for the application.
27219 * Returns: (transfer none): the default #GIcon for @appinfo.
27224 * g_volume_get_activation_root:
27225 * @volume: a #GVolume
27227 * Gets the activation root for a #GVolume if it is known ahead of
27228 * mount time. Returns %NULL otherwise. If not %NULL and if @volume
27229 * is mounted, then the result of g_mount_get_root() on the
27230 * #GMount object obtained from g_volume_get_mount() will always
27231 * either be equal or a prefix of what this function returns. In
27232 * other words, in code
27235 * GFile *mount_root
27236 * GFile *volume_activation_root;
27237 * mount = g_volume_get_mount (volume); /* mounted, so never NULL */
27238 * mount_root = g_mount_get_root (mount);
27239 * volume_activation_root = g_volume_get_activation_root(volume); /* assume not NULL */
27240 * </programlisting>
27241 * then the expression
27243 * (g_file_has_prefix (volume_activation_root, mount_root) ||
27244 * </programlisting>
27245 * will always be %TRUE.
27246 * Activation roots are typically used in #GVolumeMonitor
27247 * implementations to find the underlying mount to shadow, see
27248 * g_mount_is_shadowed() for more details.
27249 * g_object_unref() to free.
27251 * Returns: (transfer full): the activation root of @volume or %NULL. Use
27257 * g_dbus_message_set_destination:
27258 * @message: A #GDBusMessage.
27259 * @value: The value to set.
27261 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
27270 * The fundamental type corresponding to #GVariant.
27271 * All floating #GVariant instances passed through the #GType system are
27273 * Note that callbacks in closures, and signal handlers
27274 * for signals of return type %G_TYPE_VARIANT, must never return floating
27276 * with this fundamental type in 2.26.
27278 * Note: GLib 2.24 did include a boxed type with this name. It was replaced
27285 * @volume: a #GVolume.
27286 * @flags: flags affecting the unmount if required for eject
27287 * @cancellable: optional #GCancellable object, %NULL to ignore.
27288 * @callback: a #GAsyncReadyCallback, or %NULL.
27289 * @user_data: user data that gets passed to @callback
27291 * Ejects a volume. This is an asynchronous operation, and is
27292 * finished by calling g_volume_eject_finish() with the @volume
27293 * and #GAsyncResult returned in the @callback.
27295 * Deprecated: 2.22: Use g_volume_eject_with_operation() instead.
27300 * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
27302 * The string used to obtain a Unix device path with g_volume_get_identifier().
27307 * g_signal_handlers_unblock_by_func:
27308 * @instance: The instance to unblock handlers from.
27309 * @func: The C closure callback of the handlers (useless for non-C closures).
27310 * @data: The closure data of the handlers' closures.
27312 * Unblocks all handlers on an instance that match @func and @data.
27314 * Returns: The number of handlers that matched.
27319 * g_tls_backend_get_default:
27321 * Gets the default #GTlsBackend for the system.
27323 * Returns: a #GTlsBackend
27329 * g_dbus_message_new:
27331 * Creates a new empty #GDBusMessage.
27333 * Returns: A #GDBusMessage. Free with g_object_unref().
27339 * g_dbus_message_get_arg0:
27340 * @message: A #GDBusMessage.
27342 * Convenience to get the first item in the body of @message.
27344 * Returns: The string item or %NULL if the first item in the body of
27350 * g_drive_is_media_removable:
27351 * @drive: a #GDrive.
27353 * Checks if the @drive supports removable media.
27355 * Returns: %TRUE if @drive supports removable media, %FALSE otherwise.
27360 * g_unix_socket_address_get_address_type:
27361 * @address: a #GInetSocketAddress
27363 * Gets @address's type.
27365 * Returns: a #GUnixSocketAddressType
27371 * SECTION:gtlsconnectio:
27372 * @short_description: TLS connection type
27373 * @include: gio/gio.h
27375 * #GTlsConnection is the base TLS connection class type, which wraps
27376 * a #GIOStream and provides TLS encryption on top of it. Its
27377 * subclasses, #GTlsClientConnection and #GTlsServerConnection,
27378 * implement client-side and server-side TLS, respectively.
27385 * G_PARAM_SPEC_FLAGS:
27386 * @pspec: a valid #GParamSpec instance
27388 * Cast a #GParamSpec instance into a #GParamSpecFlags.
27393 * g_tls_backend_get_server_connection_type:
27394 * @backend: the #GTlsBackend
27396 * Gets the #GType of @backend's #GTlsServerConnection implementation.
27399 * Returns: the #GType of @backend's #GTlsServerConnection
27406 * @G_TLS_ERROR_UNAVAILABLE: No TLS provider is available
27407 * @G_TLS_ERROR_MISC: Miscellaneous TLS error
27408 * @G_TLS_ERROR_BAD_CERTIFICATE: A certificate could not be parsed
27409 * @G_TLS_ERROR_NOT_TLS: The TLS handshake failed because the peer does not seem to be a TLS server.
27410 * @G_TLS_ERROR_HANDSHAKE: The TLS handshake failed because the peer's certificate was not acceptable.
27411 * @G_TLS_ERROR_CERTIFICATE_REQUIRED: The TLS handshake failed because the server requested a client-side certificate, but none was provided. See g_tls_connection_set_certificate().
27412 * @G_TLS_ERROR_EOF: The TLS connection was closed without proper notice, which may indicate an attack. See g_tls_connection_set_require_close_notify().
27414 * An error code used with %G_TLS_ERROR in a #GError returned from a
27415 * TLS-related routine.
27422 * g_data_output_stream_put_byte:
27423 * @stream: a #GDataOutputStream.
27424 * @data: a #guchar.
27425 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
27426 * @error: a #GError, %NULL to ignore.
27428 * Puts a byte into the output stream.
27430 * Returns: %TRUE if @data was successfully added to the @stream.
27435 * G_PRIORITY_HIGH_IDLE:
27437 * Use this for high priority idle functions.
27438 * GTK+ uses #G_PRIORITY_HIGH_IDLE + 10 for resizing operations,
27439 * and #G_PRIORITY_HIGH_IDLE + 20 for redrawing operations. (This is
27440 * done to ensure that any pending resizes are processed before any
27441 * pending redraws, so that widgets are not redrawn twice unnecessarily.)
27448 * Error domain for TLS. Errors in this domain will be from the
27449 * #GTlsError enumeration. See #GError for more information on error
27455 * G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC:
27457 * A key in the "time" namespace for getting the miliseconds of the time
27458 * the file was last modified. This should be used in conjunction with
27459 * #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is
27460 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
27465 * g_drive_eject_finish:
27466 * @drive: a #GDrive.
27467 * @result: a #GAsyncResult.
27468 * @error: a #GError, or %NULL
27470 * Finishes ejecting a drive.
27471 * %FALSE otherwise.
27473 * Returns: %TRUE if the drive has been ejected successfully,
27474 * Deprecated: 2.22: Use g_drive_eject_with_operation_finish() instead.
27480 * @parent_instance: private #GParamSpec portion
27481 * @minimum: minimum value for the property specified
27482 * @maximum: maximum value for the property specified
27483 * @default_value: default value for the property specified
27484 * @epsilon: values closer than @epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-30.
27486 * A #GParamSpec derived structure that contains the meta data for float properties.
27491 * g_app_info_can_delete:
27492 * @appinfo: a #GAppInfo
27494 * Obtains the information whether the #GAppInfo can be deleted.
27495 * See g_app_info_delete().
27497 * Returns: %TRUE if @appinfo can be deleted
27503 * GApplicationCommandLineClass:
27505 * The <structname>GApplicationCommandLineClass</structname> structure contains
27506 * private data only
27513 * g_dbus_interface_info_generate_xml:
27514 * @info: A #GDBusNodeInfo
27515 * @indent: Indentation level.
27516 * @string_builder: A #GString to to append XML data to.
27518 * Appends an XML representation of @info (and its children) to @string_builder.
27519 * This function is typically used for generating introspection XML
27520 * documents at run-time for handling the
27521 * <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>
27529 * GTlsConnection:base-io-stream:
27531 * The #GIOStream that the connection wraps
27538 * g_network_service_get_service:
27539 * @srv: a #GNetworkService
27541 * Gets @srv's service name (eg, "ldap").
27543 * Returns: @srv's service name
27549 * G_TYPE_IS_INSTANTIATABLE:
27550 * @type: A #GType value.
27552 * Checks if @type can be instantiated. Instantiation is the
27553 * process of creating an instance (object) of this type.
27555 * Returns: %TRUE on success.
27560 * GThreadedSocketService::run:
27561 * @service: the #GThreadedSocketService.
27562 * @connection: a new #GSocketConnection object.
27563 * @source_object: the source_object passed to g_socket_listener_add_address().
27565 * The ::run signal is emitted in a worker thread in response to an
27566 * incoming connection. This thread is dedicated to handling
27567 * not return until the connection is closed.
27569 * Returns: %TRUE to stope further signal handlers from being called
27574 * g_vfs_get_file_for_path:
27576 * @path: a string containing a VFS path.
27578 * Gets a #GFile for @path.
27579 * Free the returned object with g_object_unref().
27581 * Returns: (transfer full): a #GFile.
27586 * G_TYPE_INSTANCE_GET_CLASS:
27587 * @instance: Location of the #GTypeInstance structure.
27588 * @g_type: The #GType of the class to be returned.
27589 * @c_type: The C type of the class structure.
27591 * Get the class structure of a given @instance, casted
27592 * to a specified ancestor type @g_type of the instance.
27593 * Note that while calling a GInstanceInitFunc(), the class pointer gets
27594 * modified, so it might not always return the expected pointer.
27595 * This macro should only be used in type implementations.
27597 * Returns: a pointer to the class structure
27602 * GInetAddress:is-mc-global:
27604 * Whether this is a global multicast address.
27605 * See g_inet_address_get_is_mc_global().
27612 * g_unix_fd_list_append:
27613 * @list: a #GUnixFDList
27614 * @fd: a valid open file descriptor
27615 * @error: a #GError pointer
27617 * Adds a file descriptor to @list.
27618 * The file descriptor is duplicated using dup(). You keep your copy
27619 * of the descriptor and the copy contained in @list will be closed
27620 * when @list is finalized.
27621 * A possible cause of failure is exceeding the per-process or
27622 * system-wide file descriptor limit.
27623 * The index of the file descriptor in the list is returned. If you use
27624 * this index with g_unix_fd_list_get() then you will receive back a
27625 * duplicated copy of the same file descriptor.
27626 * (and @error is set)
27628 * Returns: the index of the appended fd in case of success, else -1
27634 * g_unix_mount_point_guess_name:
27635 * @mount_point: a #GUnixMountPoint
27637 * Guesses the name of a Unix mount point.
27638 * The result is a translated string.
27639 * be freed with g_free()
27641 * Returns: A newly allocated string that must
27646 * g_dbus_message_lock:
27647 * @message: A #GDBusMessage.
27649 * If @message is locked, does nothing. Otherwise locks the message.
27656 * g_filter_input_stream_set_close_base_stream:
27657 * @stream: a #GFilterInputStream.
27658 * @close_base: %TRUE to close the base stream.
27660 * Sets whether the base stream will be closed when @stream is closed.
27665 * g_simple_async_result_complete:
27666 * @simple: a #GSimpleAsyncResult.
27668 * Completes an asynchronous I/O job immediately. Must be called in
27669 * the thread where the asynchronous result was to be delivered, as it
27670 * invokes the callback directly. If you are in a different thread use
27671 * g_simple_async_result_complete_in_idle().
27672 * Calling this function takes a reference to @simple for as long as
27673 * is needed to complete the call.
27678 * g_drive_get_icon:
27679 * @drive: a #GDrive.
27681 * Gets the icon for @drive.
27682 * Free the returned object with g_object_unref().
27684 * Returns: (transfer full): #GIcon for the @drive.
27689 * g_unix_mount_free:
27690 * @mount_entry: a #GUnixMount.
27692 * Frees a unix mount.
27697 * g_socket_listener_add_any_inet_port:
27698 * @listener: a #GSocketListener
27699 * @source_object: (allow-none): Optional #GObject identifying this source
27700 * @error: a #GError location to store the error occuring, or %NULL to ignore.
27702 * Listens for TCP connections on any available port number for both
27703 * IPv6 and IPv4 (if each are available).
27704 * This is useful if you need to have a socket for incoming connections
27705 * but don't care about the specific port number.
27706 * to accept to identify this particular source, which is
27707 * useful if you're listening on multiple addresses and do
27708 * different things depending on what address is connected to.
27710 * Returns: the port number, or 0 in case of failure.
27716 * g_unix_mount_point_get_fs_type:
27717 * @mount_point: a #GUnixMountPoint.
27719 * Gets the file system type for the mount point.
27721 * Returns: a string containing the file system type.
27728 * The fundamental type corresponding to #gint.
27733 * g_file_output_stream_query_info:
27734 * @stream: a #GFileOutputStream.
27735 * @attributes: a file attribute query string.
27736 * @cancellable: optional #GCancellable object, %NULL to ignore.
27737 * @error: a #GError, %NULL to ignore.
27739 * Queries a file output stream for the given @attributes.
27740 * This function blocks while querying the stream. For the asynchronous
27741 * version of this function, see g_file_output_stream_query_info_async().
27742 * While the stream is blocked, the stream will set the pending flag
27743 * internally, and any other operations on the stream will fail with
27744 * %G_IO_ERROR_PENDING.
27745 * Can fail if the stream was already closed (with @error being set to
27746 * %G_IO_ERROR_CLOSED), the stream has pending operations (with @error being
27747 * set to %G_IO_ERROR_PENDING), or if querying info is not supported for
27748 * the stream's interface (with @error being set to %G_IO_ERROR_NOT_SUPPORTED). In
27749 * all cases of failure, %NULL will be returned.
27750 * If @cancellable is not %NULL, then the operation can be cancelled by
27751 * triggering the cancellable object from another thread. If the operation
27752 * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
27755 * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
27760 * GDBusSubtreeIntrospectFunc:
27761 * @connection: A #GDBusConnection.
27762 * @sender: The unique bus name of the remote caller.
27763 * @object_path: The object path that was registered with g_dbus_connection_register_subtree().
27764 * @node: A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree.
27765 * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
27767 * The type of the @introspect function in #GDBusSubtreeVTable.
27768 * Subtrees are flat. @node, if non-%NULL, is always exactly one
27769 * This function should return %NULL to indicate that there is no object
27771 * If this function returns non-%NULL, the return value is expected to
27772 * be a %NULL-terminated array of pointers to #GDBusInterfaceInfo
27773 * structures describing the interfaces implemented by @node. This
27774 * array will have g_dbus_interface_info_unref() called on each item
27775 * before being freed with g_free().
27776 * The difference between returning %NULL and an array containing zero
27777 * items is that the standard DBus interfaces will returned to the
27778 * remote introspector in the empty array case, but not in the %NULL
27781 * Segment of the object path (ie: it never contains a slash).
27782 * Returns: A %NULL-terminated array of pointers to #GDBusInterfaceInfo, or %NULL.
27788 * g_data_input_stream_read_until_async:
27789 * @stream: a given #GDataInputStream.
27790 * @stop_chars: characters to terminate the read.
27791 * @io_priority: the <link linkend="io-priority">I/O priority</link> of the request.
27792 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
27793 * @callback: (scope async): callback to call when the request is satisfied.
27794 * @user_data: (closure): the data to pass to callback function.
27796 * The asynchronous version of g_data_input_stream_read_until().
27797 * It is an error to have two outstanding calls to this function.
27798 * Note that, in contrast to g_data_input_stream_read_until(),
27799 * this function does not consume the stop character that it finds. You
27800 * must read it for yourself.
27801 * When the operation is finished, @callback will be called. You
27802 * can then call g_data_input_stream_read_until_finish() to get
27803 * the result of the operation.
27804 * Don't use this function in new code. Its functionality is
27805 * inconsistent with g_data_input_stream_read_until(). Both functions
27806 * will be marked as deprecated in a future release. Use
27807 * g_data_input_stream_read_upto_async() instead.
27814 * GFileAttributeStatus:
27815 * @G_FILE_ATTRIBUTE_STATUS_UNSET: Attribute value is unset (empty).
27816 * @G_FILE_ATTRIBUTE_STATUS_SET: Attribute value is set.
27817 * @G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING: Indicates an error in setting the value.
27819 * Used by g_file_set_attributes_from_info() when setting file attributes.
27824 * g_dbus_error_register_error:
27825 * @error_domain: A #GQuark for a error domain.
27826 * @error_code: An error code.
27827 * @dbus_error_name: A D-Bus error name.
27829 * Creates an association to map between @dbus_error_name and
27830 * #GError<!-- -->s specified by @error_domain and @error_code.
27831 * This is typically done in the routine that returns the #GQuark for
27835 * Returns: %TRUE if the association was created, %FALSE if it already
27841 * GDBusProxy::g-signal:
27842 * @proxy: The #GDBusProxy emitting the signal.
27843 * @sender_name: The sender of the signal or %NULL if the connection is not a bus connection.
27844 * @signal_name: The name of the signal.
27845 * @parameters: A #GVariant tuple with parameters for the signal.
27847 * Emitted when a signal from the remote object and interface that @proxy is for, has been received.
27854 * g_filename_completer_set_dirs_only:
27855 * @completer: the filename completer.
27856 * @dirs_only: a #gboolean.
27858 * If @dirs_only is %TRUE, @completer will only
27859 * complete directory names, and not file names.
27864 * g_simple_async_report_gerror_in_idle:
27865 * @object: (allow-none): a #GObject, or %NULL
27866 * @callback: (scope async): a #GAsyncReadyCallback.
27867 * @user_data: (closure): user data passed to @callback.
27868 * @error: the #GError to report
27870 * Reports an error in an idle function. Similar to
27871 * g_simple_async_report_error_in_idle(), but takes a #GError rather
27872 * than building a new one.
27877 * g_volume_monitor_get_mounts:
27878 * @volume_monitor: a #GVolumeMonitor.
27880 * Gets a list of the mounts on the system.
27881 * The returned list should be freed with g_list_free(), after
27882 * its elements have been unreffed with g_object_unref().
27884 * Returns: (element-type GMount) (transfer full): a #GList of #GMount objects.
27889 * g_signal_handlers_disconnect_by_func:
27890 * @instance: The instance to remove handlers from.
27891 * @func: The C closure callback of the handlers (useless for non-C closures).
27892 * @data: The closure data of the handlers' closures.
27894 * Disconnects all handlers on an instance that match @func and @data.
27896 * Returns: The number of handlers that matched.
27901 * g_dbus_proxy_get_connection:
27902 * @proxy: A #GDBusProxy.
27904 * Gets the connection @proxy is for.
27906 * Returns: (transfer none): A #GDBusConnection owned by @proxy. Do not free.
27912 * g_win32_input_stream_get_close_handle:
27913 * @stream: a #GWin32InputStream
27915 * Returns whether the handle of @stream will be
27916 * closed when the stream is closed.
27918 * Returns: %TRUE if the handle is closed when done
27924 * g_unix_mount_is_system_internal:
27925 * @mount_entry: a #GUnixMount.
27927 * Checks if a unix mount is a system path.
27929 * Returns: %TRUE if the unix mount is for a system path.
27934 * g_settings_list_keys:
27935 * @settings: a #GSettings object
27936 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
27938 * Introspects the list of keys on @settings.
27939 * You should probably not be calling this function from "normal" code
27940 * (since you should already know what keys are in your schema). This
27941 * function is intended for introspection reasons.
27942 * You should free the return value with g_strfreev() when you are done
27948 * g_file_info_get_content_type:
27949 * @info: a #GFileInfo.
27951 * Gets the file's content type.
27953 * Returns: a string containing the file's content type.
27958 * g_tls_client_connection_set_validation_flags:
27959 * @conn: the #GTlsClientConnection
27960 * @flags: the #GTlsCertificateFlags to use
27962 * Sets @conn's validation flags, to override the default set of
27963 * checks performed when validating a server certificate. By default,
27964 * %G_TLS_CERTIFICATE_VALIDATE_ALL is used.
27971 * g_socket_address_enumerator_next_finish:
27972 * @enumerator: a #GSocketAddressEnumerator
27973 * @result: a #GAsyncResult
27974 * @error: a #GError
27976 * Retrieves the result of a completed call to
27977 * g_socket_address_enumerator_next_async(). See
27978 * g_socket_address_enumerator_next() for more information about
27980 * error (in which case *@error will be set) or if there are no
27983 * Returns: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on
27989 * @name: the name of the module
27991 * The members of the <structname>GTypeModule</structname> structure should not
27992 * be accessed directly, except for the @name field.
27997 * g_unix_socket_address_new_abstract:
27998 * @path: (array length=path_len) (element-type gchar): the abstract name
27999 * @path_len: the length of @path, or -1
28001 * Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
28002 * #GUnixSocketAddress for @path.
28004 * Returns: a new #GUnixSocketAddress
28005 * Deprecated: Use g_unix_socket_address_new_with_type().
28012 * Base class for streaming input operations.
28017 * g_file_get_child:
28018 * @file: input #GFile.
28019 * @name: string containing the child's basename.
28021 * Gets a child of @file with basename equal to @name.
28022 * Note that the file with that specific name might not exist, but
28023 * you can still have a #GFile that points to it. You can use this
28024 * for instance to create that file.
28025 * This call does no blocking i/o.
28026 * Free the returned object with g_object_unref().
28028 * Returns: (transfer full): a #GFile to a child specified by @name.
28034 * @settings: a #GSettings object
28035 * @key: the name of the key to set
28036 * @format: a #GVariant format string
28037 * @...: arguments as per @format
28038 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
28040 * Sets @key in @settings to @value.
28041 * A convenience function that combines g_settings_set_value() with
28043 * It is a programmer error to give a @key that isn't contained in the
28044 * schema for @settings or for the #GVariantType of @format to mismatch
28045 * the type given in the schema.
28052 * GFileAttributeInfoFlags:
28053 * @G_FILE_ATTRIBUTE_INFO_NONE: no flags set.
28054 * @G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE: copy the attribute values when the file is copied.
28055 * @G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED: copy the attribute values when the file is moved.
28057 * Flags specifying the behaviour of an attribute.
28062 * G_VALUE_HOLDS_ULONG:
28063 * @value: a valid #GValue structure
28065 * Checks whether the given #GValue can hold values of type %G_TYPE_ULONG.
28067 * Returns: %TRUE on success.
28072 * GUnixInputStream:
28074 * Implements #GInputStream for reading from selectable unix file descriptors
28079 * g_application_set_action_group:
28080 * @application: a #GApplication
28081 * @action_group: (allow-none): a #GActionGroup, or %NULL
28083 * Sets or unsets the group of actions associated with the application.
28084 * These actions are the actions that can be remotely invoked.
28085 * It is an error to call this function after the application has been
28093 * g_volume_mount_finish:
28094 * @volume: a #GVolume
28095 * @result: a #GAsyncResult
28096 * @error: a #GError location to store an error, or %NULL to ignore
28098 * Finishes mounting a volume. If any errors occured during the operation,
28099 * If the mount operation succeeded, g_volume_get_mount() on @volume
28100 * is guaranteed to return the mount right after calling this
28101 * function; there's no need to listen for the 'mount-added' signal on
28104 * Returns: %TRUE, %FALSE if operation failed.
28109 * g_file_find_enclosing_mount:
28110 * @file: input #GFile.
28111 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
28112 * @error: a #GError.
28114 * Gets a #GMount for the #GFile.
28115 * If the #GFileIface for @file does not have a mount (e.g. possibly a
28116 * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
28117 * will be returned.
28118 * If @cancellable is not %NULL, then the operation can be cancelled by
28119 * triggering the cancellable object from another thread. If the operation
28120 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
28121 * Free the returned object with g_object_unref().
28123 * Returns: (transfer full): a #GMount where the @file is located or %NULL on error.
28129 * @G_CONVERTER_NO_FLAGS: No flags.
28130 * @G_CONVERTER_INPUT_AT_END: At end of input data
28131 * @G_CONVERTER_FLUSH: Flush data
28133 * Flags used when calling a g_converter_convert().
28141 * @g_class: The #GTypeClass structure to initialize.
28142 * @class_data: The @class_data member supplied via the #GTypeInfo structure.
28144 * A callback function used by the type system to initialize the class
28145 * of a specific type. This function should initialize all static class
28147 * The initialization process of a class involves:
28150 * 1 - Copying common members from the parent class over to the
28151 * derived class structure.
28152 * </para></listitem>
28154 * 2 - Zero initialization of the remaining members not copied
28155 * over from the parent class.
28156 * </para></listitem>
28158 * 3 - Invocation of the GBaseInitFunc() initializers of all parent
28159 * types and the class' type.
28160 * </para></listitem>
28162 * 4 - Invocation of the class' GClassInitFunc() initializer.
28163 * </para></listitem>
28165 * Since derived classes are partially initialized through a memory copy
28166 * of the parent class, the general rule is that GBaseInitFunc() and
28167 * GBaseFinalizeFunc() should take care of necessary reinitialization
28168 * and release of those class members that were introduced by the type
28169 * that specified these GBaseInitFunc()/GBaseFinalizeFunc().
28170 * GClassInitFunc() should only care about initializing static
28171 * class members, while dynamic class members (such as allocated strings
28172 * or reference counted resources) are better handled by a GBaseInitFunc()
28173 * for this type, so proper initialization of the dynamic class members
28174 * is performed for class initialization of derived types as well.
28175 * An example may help to correspond the intend of the different class
28179 * GObjectClass parent_class;
28180 * gint static_integer;
28181 * gchar *dynamic_string;
28184 * type_a_base_class_init (TypeAClass *class)
28186 * class->dynamic_string = g_strdup ("some string");
28189 * type_a_base_class_finalize (TypeAClass *class)
28191 * g_free (class->dynamic_string);
28194 * type_a_class_init (TypeAClass *class)
28196 * class->static_integer = 42;
28199 * TypeAClass parent_class;
28200 * gfloat static_float;
28201 * GString *dynamic_gstring;
28204 * type_b_base_class_init (TypeBClass *class)
28206 * class->dynamic_gstring = g_string_new ("some other string");
28209 * type_b_base_class_finalize (TypeBClass *class)
28211 * g_string_free (class->dynamic_gstring);
28214 * type_b_class_init (TypeBClass *class)
28216 * class->static_float = 3.14159265358979323846;
28219 * Initialization of TypeBClass will first cause initialization of
28220 * TypeAClass (derived classes reference their parent classes, see
28221 * g_type_class_ref() on this).
28222 * Initialization of TypeAClass roughly involves zero-initializing its fields,
28223 * then calling its GBaseInitFunc() type_a_base_class_init() to allocate
28224 * its dynamic members (dynamic_string), and finally calling its GClassInitFunc()
28225 * type_a_class_init() to initialize its static members (static_integer).
28226 * The first step in the initialization process of TypeBClass is then
28227 * a plain memory copy of the contents of TypeAClass into TypeBClass and
28228 * zero-initialization of the remaining fields in TypeBClass.
28229 * The dynamic members of TypeAClass within TypeBClass now need
28230 * reinitialization which is performed by calling type_a_base_class_init()
28231 * with an argument of TypeBClass.
28232 * After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init()
28233 * is called to allocate the dynamic members of TypeBClass (dynamic_gstring),
28234 * and finally the GClassInitFunc() of TypeBClass, type_b_class_init(),
28235 * is called to complete the initialization process with the static members
28237 * Corresponding finalization counter parts to the GBaseInitFunc() functions
28238 * have to be provided to release allocated resources at class finalization
28244 * GSocketConnection:
28246 * A socket connection GIOStream object for connection-oriented sockets.
28253 * g_settings_set_double:
28254 * @settings: a #GSettings object
28255 * @key: the name of the key to set
28256 * @value: the value to set it to
28257 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
28259 * Sets @key in @settings to @value.
28260 * A convenience variant of g_settings_set() for doubles.
28261 * It is a programmer error to give a @key that isn't specified as
28262 * having a 'double' type in the schema for @settings.
28271 * A <structname>GOptionContext</structname> struct defines which options
28272 * are accepted by the commandline option parser. The struct has only private
28273 * fields and should not be directly accessed.
28278 * GThemedIcon:name:
28285 * GTlsClientConnection:accepted-cas:
28287 * A list of the distinguished names of the Certificate Authorities
28288 * that the server will accept client certificates signed by. If the
28289 * server requests a client certificate during the handshake, then
28290 * this property will be set after the handshake completes.
28291 * Each item in the list is a #GByteArray which contains the complete
28292 * subject DN of the certificate authority.
28294 * Type: GList<GByteArray>
28301 * g_data_output_stream_set_byte_order:
28302 * @stream: a #GDataOutputStream.
28303 * @order: a %GDataStreamByteOrder.
28305 * Sets the byte order of the data output stream to @order.
28310 * G_VALUE_TYPE_NAME:
28311 * @value: A #GValue structure.
28313 * Gets the the type name of @value.
28315 * Returns: the type name.
28320 * g_inet_address_to_string:
28321 * @address: a #GInetAddress
28323 * Converts @address to string form.
28326 * Returns: a representation of @address as a string, which should be
28332 * g_settings_set_strv:
28333 * @settings: a #GSettings object
28334 * @key: the name of the key to set
28335 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
28336 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
28338 * Sets @key in @settings to @value.
28339 * A convenience variant of g_settings_set() for string arrays. If
28340 * It is a programmer error to give a @key that isn't specified as
28341 * having an array of strings type in the schema for @settings.
28348 * g_dbus_method_invocation_return_error_valist:
28349 * @invocation: A #GDBusMethodInvocation.
28350 * @domain: A #GQuark for the #GError error domain.
28351 * @code: The error code.
28352 * @format: printf()-style format.
28353 * @var_args: #va_list of parameters for @format.
28355 * Like g_dbus_method_invocation_return_error() but intended for
28356 * language bindings.
28357 * This method will free @invocation, you cannot use it afterwards.
28364 * g_action_group_action_state_changed:
28365 * @action_group: a #GActionGroup
28366 * @action_name: the name of an action in the group
28367 * @state: the new state of the named action
28369 * Emits the #GActionGroup::action-state-changed signal on @action_group.
28370 * This function should only be called by #GActionGroup implementations.
28377 * SECTION:gfileoutputstrea:
28378 * @short_description: File output streaming operations
28379 * @include: gio/gio.h
28380 * @see_also: #GOutputStream, #GDataOutputStream, #GSeekable
28382 * GFileOutputStream provides output streams that write their
28383 * content to a file.
28384 * GFileOutputStream implements #GSeekable, which allows the output
28385 * stream to jump to arbitrary positions in the file and to truncate
28386 * the file, provided the filesystem of the file supports these
28388 * To find the position of a file output stream, use g_seekable_tell().
28389 * To find out if a file output stream supports seeking, use
28390 * g_seekable_can_seek().To position a file output stream, use
28391 * g_seekable_seek(). To find out if a file output stream supports
28392 * truncating, use g_seekable_can_truncate(). To truncate a file output
28393 * stream, use g_seekable_truncate().
28399 * @g_iface: The parent interface.
28400 * @dup: Duplicates a #GFile.
28401 * @hash: Creates a hash of a #GFile.
28402 * @equal: Checks equality of two given #GFile<!-- -->s.
28403 * @is_native: Checks to see if a file is native to the system.
28404 * @has_uri_scheme: Checks to see if a #GFile has a given URI scheme.
28405 * @get_uri_scheme: Gets the URI scheme for a #GFile.
28406 * @get_basename: Gets the basename for a given #GFile.
28407 * @get_path: Gets the current path within a #GFile.
28408 * @get_uri: Gets a URI for the path within a #GFile.
28409 * @get_parse_name: Gets the parsed name for the #GFile.
28410 * @get_parent: Gets the parent directory for the #GFile.
28411 * @prefix_matches: Checks whether a #GFile contains a specified file.
28412 * @get_relative_path: Gets the path for a #GFile relative to a given path.
28413 * @resolve_relative_path: Resolves a relative path for a #GFile to an absolute path.
28414 * @get_child_for_display_name: Gets the child #GFile for a given display name.
28415 * @enumerate_children: Gets a #GFileEnumerator with the children of a #GFile.
28416 * @enumerate_children_async: Asynchronously gets a #GFileEnumerator with the children of a #GFile.
28417 * @enumerate_children_finish: Finishes asynchronously enumerating the children.
28418 * @query_info: Gets the #GFileInfo for a #GFile.
28419 * @query_info_async: Asynchronously gets the #GFileInfo for a #GFile.
28420 * @query_info_finish: Finishes an asynchronous query info operation.
28421 * @query_filesystem_info: Gets a #GFileInfo for the file system #GFile is on.
28422 * @query_filesystem_info_async: Asynchronously gets a #GFileInfo for the file system #GFile is on.
28423 * @query_filesystem_info_finish: Finishes asynchronously getting the file system info.
28424 * @find_enclosing_mount: Gets a #GMount for the #GFile.
28425 * @find_enclosing_mount_async: Asynchronously gets the #GMount for a #GFile.
28426 * @find_enclosing_mount_finish: Finishes asynchronously getting the volume.
28427 * @set_display_name: Sets the display name for a #GFile.
28428 * @set_display_name_async: Asynchronously sets a #GFile's display name.
28429 * @set_display_name_finish: Finishes asynchronously setting a #GFile's display name.
28430 * @query_settable_attributes: Returns a list of #GFileAttribute<!-- -->s that can be set.
28431 * @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttribute<!-- -->s that can be set.
28432 * @_query_settable_attributes_finish: Finishes asynchronously querying settable attributes.
28433 * @query_writable_namespaces: Returns a list of #GFileAttribute namespaces that are writable.
28434 * @_query_writable_namespaces_async: Asynchronously gets a list of #GFileAttribute namespaces that are writable.
28435 * @_query_writable_namespaces_finish: Finishes asynchronously querying the writable namespaces.
28436 * @set_attribute: Sets a #GFileAttribute.
28437 * @set_attributes_from_info: Sets a #GFileAttribute with information from a #GFileInfo.
28438 * @set_attributes_async: Asynchronously sets a file's attributes.
28439 * @set_attributes_finish: Finishes setting a file's attributes asynchronously.
28440 * @read_fn: Reads a file asynchronously.
28441 * @read_async: Asynchronously reads a file.
28442 * @read_finish: Finishes asynchronously reading a file.
28443 * @append_to: Writes to the end of a file.
28444 * @append_to_async: Asynchronously writes to the end of a file.
28445 * @append_to_finish: Finishes an asynchronous file append operation.
28446 * @create: Creates a new file.
28447 * @create_async: Asynchronously creates a file.
28448 * @create_finish: Finishes asynchronously creating a file.
28449 * @replace: Replaces the contents of a file.
28450 * @replace_async: Asynchronously replaces the contents of a file.
28451 * @replace_finish: Finishes asynchronously replacing a file.
28452 * @delete_file: Deletes a file.
28453 * @_delete_file_async: Asynchronously deletes a file.
28454 * @_delete_file_finish: Finishes an asynchronous delete.
28455 * @trash: Sends a #GFile to the Trash location.
28456 * @_trash_async: Asynchronously sends a #GFile to the Trash location.
28457 * @_trash_finish: Finishes an asynchronous file trashing operation.
28458 * @make_directory: Makes a directory.
28459 * @_make_directory_async: Asynchronously makes a directory.
28460 * @_make_directory_finish: Finishes making a directory asynchronously.
28461 * @make_symbolic_link: Makes a symbolic link.
28462 * @_make_symbolic_link_async: Asynchronously makes a symbolic link
28463 * @_make_symbolic_link_finish: Finishes making a symbolic link asynchronously.
28464 * @copy: Copies a file.
28465 * @copy_async: Asynchronously copies a file.
28466 * @copy_finish: Finishes an asynchronous copy operation.
28467 * @move: Moves a file.
28468 * @_move_async: Asynchronously moves a file.
28469 * @_move_finish: Finishes an asynchronous move operation.
28470 * @mount_mountable: Mounts a mountable object.
28471 * @mount_mountable_finish: Finishes a mounting operation.
28472 * @unmount_mountable: Unmounts a mountable object.
28473 * @unmount_mountable_finish: Finishes an unmount operation.
28474 * @eject_mountable: Ejects a mountable.
28475 * @eject_mountable_finish: Finishes an eject operation.
28476 * @mount_enclosing_volume: Mounts a specified location.
28477 * @mount_enclosing_volume_finish: Finishes mounting a specified location.
28478 * @monitor_dir: Creates a #GFileMonitor for the location.
28479 * @monitor_file: Creates a #GFileMonitor for the location.
28480 * @open_readwrite: Open file read/write. Since 2.22.
28481 * @open_readwrite_async: Asynchronously opens file read/write. Since 2.22.
28482 * @open_readwrite_finish: Finishes an asynchronous open read/write. Since 2.22.
28483 * @create_readwrite: Creates file read/write. Since 2.22.
28484 * @create_readwrite_async: Asynchronously creates file read/write. Since 2.22.
28485 * @create_readwrite_finish: Finishes an asynchronous creates read/write. Since 2.22.
28486 * @replace_readwrite: Replaces file read/write. Since 2.22.
28487 * @replace_readwrite_async: Asynchronously replaces file read/write. Since 2.22.
28488 * @replace_readwrite_finish: Finishes an asynchronous replace read/write. Since 2.22.
28489 * @start_mountable: Starts a mountable object. Since 2.22.
28490 * @start_mountable_finish: Finishes an start operation. Since 2.22.
28491 * @stop_mountable: Stops a mountable. Since 2.22.
28492 * @stop_mountable_finish: Finishes an stop operation. Since 2.22.
28493 * @supports_thread_contexts: a boolean that indicates whether the #GFile implementation supports thread-default contexts. Since 2.22.
28494 * @unmount_mountable_with_operation: Unmounts a mountable object using a #GMountOperation. Since 2.22.
28495 * @unmount_mountable_with_operation_finish: Finishes an unmount operation using a #GMountOperation. Since 2.22.
28496 * @eject_mountable_with_operation: Ejects a mountable object using a #GMountOperation. Since 2.22.
28497 * @eject_mountable_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
28498 * @poll_mountable: Polls a mountable object for media changes. Since 2.22.
28499 * @poll_mountable_finish: Finishes an poll operation for media changes. Since 2.22.
28501 * An interface for writing VFS file handles.
28507 * @pspec: a #GParamSpec
28509 * Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM
28515 * g_file_output_stream_query_info_finish:
28516 * @stream: a #GFileOutputStream.
28517 * @result: a #GAsyncResult.
28518 * @error: a #GError, %NULL to ignore.
28520 * Finalizes the asynchronous query started
28521 * by g_file_output_stream_query_info_async().
28523 * Returns: (transfer full): A #GFileInfo for the finished query.
28528 * G_PARAM_SPEC_LONG:
28529 * @pspec: a valid #GParamSpec instance
28531 * Cast a #GParamSpec instance into a #GParamSpecLong.
28536 * GInterfaceFinalizeFunc:
28537 * @g_iface: The interface structure to finalize.
28538 * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure.
28540 * A callback function used by the type system to finalize an interface.
28541 * This function should destroy any internal data and release any resources
28542 * allocated by the corresponding GInterfaceInitFunc() function.
28547 * g_simple_action_group_insert:
28548 * @simple: a #GSimpleActionGroup
28549 * @action: a #GAction
28551 * Adds an action to the action group.
28552 * If the action group already contains an action with the same name as
28553 * The action group takes its own reference on @action.
28560 * G_VARIANT_TYPE_DICT_ENTRY:
28562 * An indefinite type that is a supertype of every dictionary entry
28568 * GUnixOutputStream:fd:
28570 * The file descriptor that the stream writes to.
28577 * GDBusAuthObserverClass:
28578 * @authorize_authenticated_peer: Signal class handler for the #GDBusAuthObserver::authorize-authenticated-peer signal.
28580 * Class structure for #GDBusAuthObserverClass.
28587 * G_TYPE_PARAM_UINT:
28589 * The #GType of #GParamSpecUInt.
28594 * g_application_command_line_printerr:
28595 * @cmdline: a #GApplicationCommandLine
28596 * @format: a printf-style format string
28597 * @...: arguments, as per @format
28599 * Formats a message and prints it using the stderr print handler in the
28600 * invoking process.
28601 * If @cmdline is a local invocation then this is exactly equivalent to
28602 * g_printerr(). If @cmdline is remote then this is equivalent to
28603 * calling g_printerr() in the invoking process.
28610 * GInstanceInitFunc:
28611 * @instance: The instance to initialize.
28612 * @g_class: The class of the type the instance is created for.
28614 * A callback function used by the type system to initialize a new
28615 * instance of a type. This function initializes all instance members and
28616 * allocates any resources required by it.
28617 * Initialization of a derived instance involves calling all its parent
28618 * types instance initializers, so the class member of the instance
28619 * is altered during its initialization to always point to the class that
28620 * belongs to the type the current initializer was introduced for.
28625 * g_tls_server_connection_new:
28626 * @base_io_stream: the #GIOStream to wrap
28627 * @certificate: (allow-none): the default server certificate, or %NULL
28628 * @error: #GError for error reporting, or %NULL to ignore.
28630 * Creates a new #GTlsServerConnection wrapping @base_io_stream (which
28631 * must have pollable input and output streams).
28633 * Returns: the new #GTlsServerConnection, or %NULL on error
28639 * g_data_input_stream_read_int32:
28640 * @stream: a given #GDataInputStream.
28641 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
28642 * @error: #GError for error reporting.
28644 * Reads a signed 32-bit/4-byte value from @stream.
28645 * In order to get the correct byte order for this read operation,
28646 * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
28647 * If @cancellable is not %NULL, then the operation can be cancelled by
28648 * triggering the cancellable object from another thread. If the operation
28649 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
28650 * an error occurred.
28652 * Returns: a signed 32-bit/4-byte value read from the @stream or %0 if
28658 * @G_REGEX_ERROR_COMPILE: Compilation of the regular expression failed.
28659 * @G_REGEX_ERROR_OPTIMIZE: Optimization of the regular expression failed.
28660 * @G_REGEX_ERROR_REPLACE: Replacement failed due to an ill-formed replacement string.
28661 * @G_REGEX_ERROR_MATCH: The match process failed.
28662 * @G_REGEX_ERROR_INTERNAL: Internal error of the regular expression engine. Since 2.16
28663 * @G_REGEX_ERROR_STRAY_BACKSLASH: "\\" at end of pattern. Since 2.16
28664 * @G_REGEX_ERROR_MISSING_CONTROL_CHAR: "\\c" at end of pattern. Since 2.16
28665 * @G_REGEX_ERROR_UNRECOGNIZED_ESCAPE: Unrecognized character follows "\\". Since 2.16
28666 * @G_REGEX_ERROR_QUANTIFIERS_OUT_OF_ORDER: Numbers out of order in "{}" quantifier. Since 2.16
28667 * @G_REGEX_ERROR_QUANTIFIER_TOO_BIG: Number too big in "{}" quantifier. Since 2.16
28668 * @G_REGEX_ERROR_UNTERMINATED_CHARACTER_CLASS: Missing terminating "]" for character class. Since 2.16
28669 * @G_REGEX_ERROR_INVALID_ESCAPE_IN_CHARACTER_CLASS: Invalid escape sequence in character class. Since 2.16
28670 * @G_REGEX_ERROR_RANGE_OUT_OF_ORDER: Range out of order in character class. Since 2.16
28671 * @G_REGEX_ERROR_NOTHING_TO_REPEAT: Nothing to repeat. Since 2.16
28672 * @G_REGEX_ERROR_UNRECOGNIZED_CHARACTER: Unrecognized character after "(?", "(?<" or "(?P". Since 2.16
28673 * @G_REGEX_ERROR_POSIX_NAMED_CLASS_OUTSIDE_CLASS: POSIX named classes are supported only within a class. Since 2.16
28674 * @G_REGEX_ERROR_UNMATCHED_PARENTHESIS: Missing terminating ")" or ")" without opening "(". Since 2.16
28675 * @G_REGEX_ERROR_INEXISTENT_SUBPATTERN_REFERENCE: Reference to non-existent subpattern. Since 2.16
28676 * @G_REGEX_ERROR_UNTERMINATED_COMMENT: Missing terminating ")" after comment. Since 2.16
28677 * @G_REGEX_ERROR_EXPRESSION_TOO_LARGE: Regular expression too large. Since 2.16
28678 * @G_REGEX_ERROR_MEMORY_ERROR: Failed to get memory. Since 2.16
28679 * @G_REGEX_ERROR_VARIABLE_LENGTH_LOOKBEHIND: Lookbehind assertion is not fixed length. Since 2.16
28680 * @G_REGEX_ERROR_MALFORMED_CONDITION: Malformed number or name after "(?(". Since 2.16
28681 * @G_REGEX_ERROR_TOO_MANY_CONDITIONAL_BRANCHES: Conditional group contains more than two branches. Since 2.16
28682 * @G_REGEX_ERROR_ASSERTION_EXPECTED: Assertion expected after "(?(". Since 2.16
28683 * @G_REGEX_ERROR_UNKNOWN_POSIX_CLASS_NAME: Unknown POSIX class name. Since 2.16
28684 * @G_REGEX_ERROR_POSIX_COLLATING_ELEMENTS_NOT_SUPPORTED: POSIX collating elements are not supported. Since 2.16
28685 * @G_REGEX_ERROR_HEX_CODE_TOO_LARGE: Character value in "\\x{...}" sequence is too large. Since 2.16
28686 * @G_REGEX_ERROR_INVALID_CONDITION: Invalid condition "(?(0)". Since 2.16
28687 * @G_REGEX_ERROR_SINGLE_BYTE_MATCH_IN_LOOKBEHIND: \\C not allowed in lookbehind assertion. Since 2.16
28688 * @G_REGEX_ERROR_INFINITE_LOOP: Recursive call could loop indefinitely. Since 2.16
28689 * @G_REGEX_ERROR_MISSING_SUBPATTERN_NAME_TERMINATOR: Missing terminator in subpattern name. Since 2.16
28690 * @G_REGEX_ERROR_DUPLICATE_SUBPATTERN_NAME: Two named subpatterns have the same name. Since 2.16
28691 * @G_REGEX_ERROR_MALFORMED_PROPERTY: Malformed "\\P" or "\\p" sequence. Since 2.16
28692 * @G_REGEX_ERROR_UNKNOWN_PROPERTY: Unknown property name after "\\P" or "\\p". Since 2.16
28693 * @G_REGEX_ERROR_SUBPATTERN_NAME_TOO_LONG: Subpattern name is too long (maximum 32 characters). Since 2.16
28694 * @G_REGEX_ERROR_TOO_MANY_SUBPATTERNS: Too many named subpatterns (maximum 10,000). Since 2.16
28695 * @G_REGEX_ERROR_INVALID_OCTAL_VALUE: Octal value is greater than "\\377". Since 2.16
28696 * @G_REGEX_ERROR_TOO_MANY_BRANCHES_IN_DEFINE: "DEFINE" group contains more than one branch. Since 2.16
28697 * @G_REGEX_ERROR_DEFINE_REPETION: Repeating a "DEFINE" group is not allowed. Since 2.16
28698 * @G_REGEX_ERROR_INCONSISTENT_NEWLINE_OPTIONS: Inconsistent newline options. Since 2.16
28699 * @G_REGEX_ERROR_MISSING_BACK_REFERENCE: "\\g" is not followed by a braced name or an optionally braced non-zero number. Since 2.16
28701 * Error codes returned by regular expressions functions.
28708 * GFileReadMoreCallback:
28709 * @file_contents: the data as currently read.
28710 * @file_size: the size of the data currently read.
28711 * @callback_data: data passed to the callback.
28713 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
28714 * it may become necessary to determine if any more data from the file should be loaded.
28715 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
28716 * should be read, or %FALSE otherwise.
28718 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
28723 * g_pollable_input_stream_read_nonblocking:
28724 * @stream: a #GPollableInputStream
28725 * @buffer: a buffer to read data into (which should be at least @size bytes long).
28726 * @size: the number of bytes you want to read
28727 * @cancellable: (allow-none): a #GCancellable, or %NULL
28728 * @error: #GError for error reporting, or %NULL to ignore.
28730 * Attempts to read up to @size bytes from @stream into @buffer, as
28731 * with g_input_stream_read(). If @stream is not currently readable,
28732 * this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can
28733 * use g_pollable_input_stream_create_source() to create a #GSource
28734 * that will be triggered when @stream is readable.
28735 * Note that since this method never blocks, you cannot actually
28736 * use @cancellable to cancel it. However, it will return an error
28737 * if @cancellable has already been cancelled when you call, which
28738 * may happen if you call this method after a source triggers due
28739 * to having been cancelled.
28740 * %G_IO_ERROR_WOULD_BLOCK).
28742 * Virtual: read_nonblocking
28743 * Returns: the number of bytes read, or -1 on error (including
28748 * SECTION:gioschedule:
28749 * @short_description: I/O Scheduler
28750 * @include: gio/gio.h
28752 * Schedules asynchronous I/O operations. #GIOScheduler integrates
28753 * into the main event loop (#GMainLoop) and may use threads if they
28755 * <para id="io-priority"><indexterm><primary>I/O priority</primary></indexterm>
28756 * Each I/O operation has a priority, and the scheduler uses the priorities
28757 * to determine the order in which operations are executed. They are
28758 * <emphasis>not</emphasis> used to determine system-wide I/O scheduling.
28759 * Priorities are integers, with lower numbers indicating higher priority.
28760 * It is recommended to choose priorities between %G_PRIORITY_LOW and
28761 * %G_PRIORITY_HIGH, with %G_PRIORITY_DEFAULT as a default.
28767 * SECTION:gsocketconnectio:
28768 * @short_description: A socket connection
28769 * @include: gio/gio.h
28770 * @see_also: #GIOStream, #GSocketClient, #GSocketListener
28772 * #GSocketConnection is a #GIOStream for a connected socket. They
28773 * can be created either by #GSocketClient when connecting to a host,
28774 * or by #GSocketListener when accepting a new client.
28775 * The type of the #GSocketConnection object returned from these calls
28776 * depends on the type of the underlying socket that is in use. For
28777 * instance, for a TCP/IP connection it will be a #GTcpConnection.
28778 * Chosing what type of object to construct is done with the socket
28779 * connection factory, and it is possible for 3rd parties to register
28780 * custom socket connection types for specific combination of socket
28781 * family/type/protocol using g_socket_connection_factory_register_type().
28788 * G_TIME_SPAN_SECOND:
28790 * Evaluates to a time span of one second.
28799 * The fundamental type corresponding to #guint.
28804 * g_file_monitor_directory:
28805 * @file: input #GFile.
28806 * @flags: a set of #GFileMonitorFlags.
28807 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
28808 * @error: a #GError, or %NULL.
28810 * Obtains a directory monitor for the given file.
28811 * This may fail if directory monitoring is not supported.
28812 * If @cancellable is not %NULL, then the operation can be cancelled by
28813 * triggering the cancellable object from another thread. If the operation
28814 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
28815 * Free the returned object with g_object_unref().
28817 * Virtual: monitor_dir
28818 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
28823 * GCharsetConverter:
28825 * Conversions between character sets.
28830 * G_FILE_ATTRIBUTE_TIME_CHANGED:
28832 * A key in the "time" namespace for getting the time the file was last
28833 * changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
28834 * and contains the UNIX time since the file was last changed.
28835 * This corresponds to the traditional UNIX ctime.
28840 * G_PRIORITY_DEFAULT:
28842 * Use this for default priority event sources.
28843 * In GLib this priority is used when adding timeout functions
28844 * with g_timeout_add(). In GDK this priority is used for events
28845 * from the X server.
28850 * g_settings_new_with_backend:
28851 * @schema: the name of the schema
28852 * @backend: the #GSettingsBackend to use
28853 * @returns: a new #GSettings object
28855 * Creates a new #GSettings object with a given schema and backend.
28856 * Creating settings objects with an different backend allows accessing settings
28857 * from a database other than the usual one. For example, it may make
28858 * sense to pass a backend corresponding to the "defaults" settings database on
28859 * the system to get a settings object that modifies the system default
28860 * settings instead of the settings for this user.
28868 * @type: a #GType ID
28870 * Checks whether @type "is a" %G_TYPE_PARAM.
28875 * g_dbus_error_is_remote_error:
28876 * @error: A #GError.
28878 * Checks if @error represents an error received via D-Bus from a remote peer. If so,
28879 * use g_dbus_error_get_remote_error() to get the name of the error.
28880 * %FALSE otherwise.
28882 * Returns: %TRUE if @error represents an error from a remote peer,
28888 * G_TYPE_CHECK_CLASS_CAST:
28889 * @g_class: Location of a #GTypeClass structure.
28890 * @g_type: The type to be returned.
28891 * @c_type: The corresponding C type of class structure of @g_type.
28893 * Checks that @g_class is a class structure of the type identified by @g_type
28894 * and issues a warning if this is not the case. Returns @g_class casted
28895 * to a pointer to @c_type.
28896 * This macro should only be used in type implementations.
28902 * @class: a #GEnumClass
28904 * Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM
28910 * G_FILE_ATTRIBUTE_PREVIEW_ICON:
28912 * A key in the "preview" namespace for getting a #GIcon that can be
28913 * used to get preview of the file. For example, it may be a low
28914 * resolution thumbnail without metadata. Corresponding
28915 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value
28916 * for this key should contain a #GIcon.
28923 * g_unix_mount_is_readonly:
28924 * @mount_entry: a #GUnixMount.
28926 * Checks if a unix mount is mounted read only.
28928 * Returns: %TRUE if @mount_entry is read only.
28934 * @G_CHECKSUM_MD5: Use the MD5 hashing algorithm
28935 * @G_CHECKSUM_SHA1: Use the SHA-1 hashing algorithm
28936 * @G_CHECKSUM_SHA256: Use the SHA-256 hashing algorithm
28938 * The hashing algorithm to be used by #GChecksum when performing the
28939 * digest of some data.
28940 * Note that the #GChecksumType enumeration may be extended at a later
28941 * date to include new hashing algorithm types.
28948 * g_dbus_method_invocation_return_error:
28949 * @invocation: A #GDBusMethodInvocation.
28950 * @domain: A #GQuark for the #GError error domain.
28951 * @code: The error code.
28952 * @format: printf()-style format.
28953 * @...: Parameters for @format.
28955 * Finishes handling a D-Bus method call by returning an error.
28956 * See g_dbus_error_encode_gerror() for details about what error name
28957 * will be returned on the wire. In a nutshell, if the given error is
28958 * registered using g_dbus_error_register_error() the name given
28959 * during registration is used. Otherwise, a name of the form
28960 * <literal>org.gtk.GDBus.UnmappedGError.Quark...</literal> is
28961 * used. This provides transparent mapping of #GError between
28962 * applications using GDBus.
28963 * If you are writing an application intended to be portable,
28964 * <emphasis>always</emphasis> register errors with g_dbus_error_register_error()
28965 * or use g_dbus_method_invocation_return_dbus_error().
28966 * This method will free @invocation, you cannot use it afterwards.
28973 * G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT:
28975 * Allowed characters in path elements. Includes "!$&'()*+,;=:@".
28980 * GSimpleAction:state:
28982 * The state of the action, or %NULL if the action is stateless.
28989 * g_mount_eject_with_operation:
28990 * @mount: a #GMount.
28991 * @flags: flags affecting the unmount if required for eject
28992 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
28993 * @cancellable: optional #GCancellable object, %NULL to ignore.
28994 * @callback: a #GAsyncReadyCallback, or %NULL.
28995 * @user_data: user data passed to @callback.
28997 * Ejects a mount. This is an asynchronous operation, and is
28998 * finished by calling g_mount_eject_with_operation_finish() with the @mount
28999 * and #GAsyncResult data returned in the @callback.
29006 * g_simple_action_set_enabled:
29007 * @simple: a #GSimpleAction
29008 * @enabled: whether the action is enabled
29010 * Sets the action as enabled or not.
29011 * An action must be enabled in order to be activated or in order to
29012 * have its state changed from outside callers.
29019 * GDBusInterfaceMethodCallFunc:
29020 * @connection: A #GDBusConnection.
29021 * @sender: The unique bus name of the remote caller.
29022 * @object_path: The object path that the method was invoked on.
29023 * @interface_name: The D-Bus interface name the method was invoked on.
29024 * @method_name: The name of the method that was invoked.
29025 * @parameters: A #GVariant tuple with parameters.
29026 * @invocation: A #GDBusMethodInvocation object that can be used to return a value or error.
29027 * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
29029 * The type of the @method_call function in #GDBusInterfaceVTable.
29036 * GDBusConnection::closed:
29037 * @connection: The #GDBusConnection emitting the signal.
29038 * @remote_peer_vanished: %TRUE if @connection is closed because the remote peer closed its end of the connection.
29039 * @error: A #GError with more details about the event or %NULL.
29041 * Emitted when the connection is closed.
29042 * The cause of this event can be
29045 * If g_dbus_connection_close() is called. In this case
29046 * </para></listitem>
29048 * If the remote peer closes the connection. In this case
29049 * </para></listitem>
29051 * If the remote peer sends invalid or malformed data. In this
29052 * case @remote_peer_vanished is set to %FALSE and @error
29054 * </para></listitem>
29056 * Upon receiving this signal, you should give up your reference to
29064 * G_FILE_ATTRIBUTE_ID_FILESYSTEM:
29066 * A key in the "id" namespace for getting the file system identifier.
29067 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
29068 * An example use would be during drag and drop to see if the source
29069 * and target are on the same filesystem (default to move) or not (default
29075 * g_inet_socket_address_get_address:
29076 * @address: a #GInetSocketAddress
29078 * Gets @address's #GInetAddress.
29079 * g_object_ref()'d if it will be stored
29081 * Returns: (transfer none): the #GInetAddress for @address, which must be
29087 * SECTION:gcredential:
29088 * @short_description: An object containing credentials
29089 * @include: gio/gio.h
29091 * The #GCredentials type is a reference-counted wrapper for native
29092 * credentials. This information is typically used for identifying,
29093 * authenticating and authorizing other processes.
29094 * Some operating systems supports looking up the credentials of the
29095 * remote peer of a communication endpoint - see e.g.
29096 * g_socket_get_credentials().
29097 * Some operating systems supports securely sending and receiving
29098 * credentials over a Unix Domain Socket, see
29099 * #GUnixCredentialsMessage, g_unix_connection_send_credentials() and
29100 * g_unix_connection_receive_credentials() for details.
29101 * On Linux, the native credential type is a <type>struct ucred</type>
29103 * <citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>
29104 * man page for details. This corresponds to
29105 * %G_CREDENTIALS_TYPE_LINUX_UCRED.
29106 * On FreeBSD, the native credential type is a <type>struct cmsgcred</type>.
29107 * This corresponds to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED.
29112 * SECTION:gtlsclientconnectio:
29113 * @short_description: TLS client-side connection
29114 * @include: gio/gio.h
29116 * #GTlsClientConnection is the client-side subclass of
29117 * #GTlsConnection, representing a client-side TLS connection.
29124 * GWin32OutputStream:close-handle:
29126 * Whether to close the file handle when the stream is closed.
29133 * g_file_open_readwrite:
29134 * @file: #GFile to open
29135 * @cancellable: (allow-none): a #GCancellable
29136 * @error: a #GError, or %NULL
29138 * Opens an existing file for reading and writing. The result is
29139 * a #GFileIOStream that can be used to read and write the contents of the file.
29140 * If @cancellable is not %NULL, then the operation can be cancelled by
29141 * triggering the cancellable object from another thread. If the operation
29142 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
29143 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
29144 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
29145 * Other errors are possible too, and depend on what kind of filesystem the file is on.
29146 * Note that in many non-local file cases read and write streams are not supported,
29147 * so make sure you really need to do read and write streaming, rather than
29148 * just opening for reading or writing.
29149 * Free the returned object with g_object_unref().
29151 * Returns: (transfer full): #GFileIOStream or %NULL on error.
29157 * GVolumeMonitor::volume-removed:
29158 * @volume_monitor: The volume monitor emitting the signal.
29159 * @volume: a #GVolume that was removed.
29161 * Emitted when a mountable volume is removed from the system.
29166 * g_dbus_error_encode_gerror:
29167 * @error: A #GError.
29169 * Creates a D-Bus error name to use for @error. If @error matches
29170 * a registered error (cf. g_dbus_error_register_error()), the corresponding
29171 * D-Bus error name will be returned.
29172 * Otherwise the a name of the form
29173 * <literal>org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE</literal>
29174 * will be used. This allows other GDBus applications to map the error
29175 * on the wire back to a #GError using g_dbus_error_new_for_dbus_error().
29176 * This function is typically only used in object mappings to put a
29177 * #GError on the wire. Regular applications should not use it.
29179 * Returns: A D-Bus error name (never %NULL). Free with g_free().
29185 * g_file_set_attribute_int32:
29186 * @file: input #GFile.
29187 * @attribute: a string containing the attribute's name.
29188 * @value: a #gint32 containing the attribute's new value.
29189 * @flags: a #GFileQueryInfoFlags.
29190 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
29191 * @error: a #GError, or %NULL
29193 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
29194 * If @attribute is of a different type, this operation will fail.
29195 * If @cancellable is not %NULL, then the operation can be cancelled by
29196 * triggering the cancellable object from another thread. If the operation
29197 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
29198 * in the @file, %FALSE otherwise.
29200 * Returns: %TRUE if the @attribute was successfully set to @value
29205 * GDBusServer:guid:
29207 * The guid of the server.
29214 * GProxyAddressEnumerator:
29216 * A subclass of #GSocketAddressEnumerator that takes another address
29217 * enumerator and wraps its results in #GProxyAddress<!-- -->es as
29218 * directed by the default #GProxyResolver.
29223 * SECTION:gdesktopappinf:
29224 * @title: GDesktopAppInfo
29225 * @short_description: Application information from desktop files
29226 * @include: gio/gdesktopappinfo.h
29228 * #GDesktopAppInfo is an implementation of #GAppInfo based on
29230 * Note that <filename><gio/gdesktopappinfo.h></filename> belongs to
29231 * the UNIX-specific GIO interfaces, thus you have to use the
29232 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
29238 * @error_code: An error code.
29239 * @dbus_error_name: The D-Bus error name to associate with @error_code.
29241 * Struct used in g_dbus_error_register_error_domain().
29248 * g_unix_socket_address_new_with_type:
29249 * @path: (array length=path_len) (element-type gchar): the name
29250 * @path_len: the length of @path, or -1
29251 * @type: a #GUnixSocketAddressType
29253 * Creates a new #GUnixSocketAddress of type @type with name @path.
29254 * If @type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to
29255 * calling g_unix_socket_address_new().
29256 * If @path_type is %G_UNIX_SOCKET_ADDRESS_ABSTRACT, then @path_len
29257 * bytes of @path will be copied to the socket's path, and only those
29258 * bytes will be considered part of the name. (If @path_len is -1,
29259 * then @path is assumed to be NUL-terminated.) For example, if @path
29260 * was "test", then calling g_socket_address_get_native_size() on the
29261 * returned socket would return 7 (2 bytes of overhead, 1 byte for the
29262 * abstract-socket indicator byte, and 4 bytes for the name "test").
29263 * If @path_type is %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then
29264 * rest of the path will be padded with 0 bytes, and the entire
29265 * zero-padded buffer will be considered the name. (As above, if
29266 * this case, g_socket_address_get_native_size() will always return
29267 * the full size of a <literal>struct sockaddr_un</literal>, although
29268 * g_unix_socket_address_get_path_len() will still return just the
29270 * %G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over
29271 * %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED for new programs. Of course,
29272 * when connecting to a server created by another process, you must
29273 * use the appropriate type corresponding to how that process created
29274 * its listening socket.
29276 * Returns: a new #GUnixSocketAddress
29282 * G_DEFINE_BOXED_TYPE:
29283 * @TypeName: The name of the new type, in Camel case.
29284 * @type_name: The name of the new type, in lowercase, with words separated by '_'.
29285 * @copy_func: the #GBoxedCopyFunc for the new type
29286 * @free_func: the #GBoxedFreeFunc for the new type
29288 * A convenience macro for boxed type implementations, which defines a
29289 * type_name_get_type() function registering the boxed type.
29296 * G_TYPE_VALUE_ARRAY:
29298 * The type ID of the "GValueArray" type which is a boxed type,
29299 * used to pass around pointers to GValueArrays.
29304 * G_IS_PARAM_SPEC_UINT:
29305 * @pspec: a valid #GParamSpec instance
29307 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT.
29309 * Returns: %TRUE on success.
29314 * g_application_command_line_get_arguments:
29315 * @cmdline: a #GApplicationCommandLine
29316 * @argc: (out): the length of the arguments array, or %NULL
29318 * Gets the list of arguments that was passed on the command line.
29319 * The strings in the array may contain non-utf8 data.
29320 * The return value is %NULL-terminated and should be freed using
29322 * containing the arguments (the argv)
29324 * Returns: (array length=argc) (transfer full): the string array
29330 * g_io_stream_get_input_stream:
29331 * @stream: a #GIOStream
29333 * Gets the input stream for this object. This is used
29337 * Returns: (transfer none): a #GInputStream, owned by the #GIOStream.
29343 * GDBusServer:address:
29345 * The D-Bus address to listen on.
29352 * G_INITIALLY_UNOWNED_GET_CLASS:
29353 * @object: a #GInitiallyUnowned instance.
29355 * Get the class structure associated to a #GInitiallyUnowned instance.
29357 * Returns: pointer to object class structure.
29362 * g_unix_socket_address_get_path_len:
29363 * @address: a #GInetSocketAddress
29365 * Gets the length of @address's path.
29366 * For details, see g_unix_socket_address_get_path().
29368 * Returns: the length of the path
29374 * SECTION:gfileico:
29375 * @short_description: Icons pointing to an image file
29376 * @include: gio/gio.h
29377 * @see_also: #GIcon, #GLoadableIcon
29379 * #GFileIcon specifies an icon by pointing to an image file
29380 * to be used as icon.
29385 * g_socket_listener_close:
29386 * @listener: a #GSocketListener
29388 * Closes all the sockets in the listener.
29395 * g_data_input_stream_read_line:
29396 * @stream: a given #GDataInputStream.
29397 * @length: (out): a #gsize to get the length of the data read in.
29398 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
29399 * @error: #GError for error reporting.
29401 * Reads a line from the data input stream.
29402 * If @cancellable is not %NULL, then the operation can be cancelled by
29403 * triggering the cancellable object from another thread. If the operation
29404 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
29405 * (without the newlines). Set @length to a #gsize to get the
29406 * length of the read line. On an error, it will return %NULL and
29407 * still return %NULL, but @error won't be set.
29409 * Returns: (transfer full): a string with the line that was read in
29414 * G_TYPE_CHECK_INSTANCE_TYPE:
29415 * @instance: Location of a #GTypeInstance structure.
29416 * @g_type: The type to be checked
29418 * Checks if @instance is an instance of the type identified by @g_type.
29419 * This macro should only be used in type implementations.
29421 * Returns: %TRUE on success.
29426 * SECTION:gvolumemonito:
29427 * @short_description: Volume Monitor
29428 * @include: gio/gio.h
29429 * @see_also: #GFileMonitor
29431 * #GVolumeMonitor is for listing the user interesting devices and volumes
29432 * on the computer. In other words, what a file selector or file manager
29433 * would show in a sidebar.
29434 * #GVolumeMonitor is not <link
29435 * linkend="g-main-context-push-thread-default">thread-default-context
29436 * aware</link>, and so should not be used other than from the main
29437 * thread, with no thread-default-context active.
29442 * g_dbus_connection_is_closed:
29443 * @connection: A #GDBusConnection.
29445 * Gets whether @connection is closed.
29447 * Returns: %TRUE if the connection is closed, %FALSE otherwise.
29453 * g_atomic_int_inc:
29454 * @atomic: a pointer to an integer.
29456 * Atomically increments the integer pointed to by @atomic by 1.
29463 * GCancellable::cancelled:
29464 * @cancellable: a #GCancellable.
29466 * Emitted when the operation has been cancelled.
29467 * Can be used by implementations of cancellable operations. If the
29468 * operation is cancelled from another thread, the signal will be
29469 * emitted in the thread that cancelled the operation, not the
29470 * thread that is running the operation.
29471 * Note that disconnecting from this signal (or any signal) in a
29472 * multi-threaded program is prone to race conditions. For instance
29473 * it is possible that a signal handler may be invoked even
29474 * <emphasis>after</emphasis> a call to
29475 * g_signal_handler_disconnect() for that handler has already
29477 * There is also a problem when cancellation happen
29478 * right before connecting to the signal. If this happens the
29479 * signal will unexpectedly not be emitted, and checking before
29480 * connecting to the signal leaves a race condition where this is
29482 * In order to make it safe and easy to connect handlers there
29483 * g_cancellable_disconnect() which protect against problems
29485 * An example of how to us this:
29487 * /<!-- -->* Make sure we don't do any unnecessary work if already cancelled *<!-- -->/
29488 * if (g_cancellable_set_error_if_cancelled (cancellable))
29490 * /<!-- -->* Set up all the data needed to be able to
29491 * * handle cancellation of the operation *<!-- -->/
29492 * my_data = my_data_new (...);
29495 * id = g_cancellable_connect (cancellable,
29496 * G_CALLBACK (cancelled_handler)
29498 * /<!-- -->* cancellable operation here... *<!-- -->/
29499 * g_cancellable_disconnect (cancellable, id);
29500 * /<!-- -->* cancelled_handler is never called after this, it
29501 * * is now safe to free the data *<!-- -->/
29502 * my_data_free (my_data);
29504 * Note that the cancelled signal is emitted in the thread that
29505 * the user cancelled from, which may be the main thread. So, the
29506 * cancellable signal should not do something that can block.
29508 * Are two helper functions: g_cancellable_connect() and
29513 * G_PARAM_STATIC_STRINGS:
29515 * #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB.
29521 * g_file_attribute_info_list_dup:
29522 * @list: a #GFileAttributeInfoList to duplicate.
29524 * Makes a duplicate of a file attribute info list.
29526 * Returns: a copy of the given @list.
29531 * g_app_info_get_commandline:
29532 * @appinfo: a #GAppInfo
29534 * Gets the commandline with which the application will be
29536 * or %NULL if this information is not available
29538 * Returns: a string containing the @appinfo's commandline,
29544 * g_dbus_interface_info_unref:
29545 * @info: A #GDBusInterfaceInfo.
29547 * If @info is statically allocated, does nothing. Otherwise decreases
29548 * the reference count of @info. When its reference count drops to 0,
29549 * the memory used is freed.
29556 * g_charset_converter_get_num_fallbacks:
29557 * @converter: a #GCharsetConverter
29559 * Gets the number of fallbacks that @converter has applied so far.
29561 * Returns: the number of fallbacks that @converter has applied
29567 * g_file_enumerator_is_closed:
29568 * @enumerator: a #GFileEnumerator.
29570 * Checks if the file enumerator has been closed.
29572 * Returns: %TRUE if the @enumerator is closed.
29578 * @icon: a GIcon containing the icon.
29580 * Creates a new emblem for @icon.
29582 * Returns: a new #GEmblem.
29590 * Mask containing the bits of #GParamSpec.flags which are reserved for GLib.
29595 * G_DEFINE_INTERFACE:
29596 * @TN: The name of the new type, in Camel case.
29597 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
29598 * @T_P: The #GType of the prerequisite type for the interface, or 0 (%G_TYPE_INVALID) for no prerequisite type.
29600 * A convenience macro for #GTypeInterface definitions, which declares
29601 * a default vtable initialization function and defines a *_get_type()
29603 * The macro expects the interface initialization function to have the
29604 * name <literal>t_n ## _default_init</literal>, and the interface
29605 * structure to have the name <literal>TN ## Interface</literal>.
29612 * g_file_has_uri_scheme:
29613 * @file: input #GFile.
29614 * @uri_scheme: a string containing a URI scheme.
29616 * Checks to see if a #GFile has a given URI scheme.
29617 * This call does no blocking i/o.
29618 * given URI scheme, %FALSE if URI scheme is %NULL,
29619 * not supported, or #GFile is invalid.
29621 * Returns: %TRUE if #GFile's backend supports the
29626 * g_simple_async_result_new_take_error: (skip)
29627 * @source_object: (allow-none): a #GObject, or %NULL
29628 * @callback: (scope async): a #GAsyncReadyCallback
29629 * @user_data: (closure): user data passed to @callback
29630 * @error: a #GError
29632 * Creates a #GSimpleAsyncResult from an error condition, and takes over the
29633 * caller's ownership of @error, so the caller does not need to free it anymore.
29635 * Returns: a #GSimpleAsyncResult
29641 * SECTION:gsimpleactiongrou:
29642 * @title: GSimpleActionGroup
29643 * @short_description: A simple GActionGroup implementation
29645 * #GSimpleActionGroup is a hash table filled with #GAction objects,
29646 * implementing the #GActionGroup interface.
29651 * GSocketConnectableIface:
29652 * @g_iface: The parent interface.
29653 * @enumerate: Creates a #GSocketAddressEnumerator
29654 * @proxy_enumerate: Creates a #GProxyAddressEnumerator
29656 * Provides an interface for returning a #GSocketAddressEnumerator
29657 * and #GProxyAddressEnumerator
29662 * GPermission:can-release:
29664 * %TRUE if it is generally possible to release the permission by calling
29665 * g_permission_release().
29670 * SECTION:gwin32inputstrea:
29671 * @short_description: Streaming input operations for Windows file handles
29672 * @include: gio/gwin32inputstream.h
29673 * @see_also: #GInputStream
29675 * #GWin32InputStream implements #GInputStream for reading from a
29676 * Windows file handle.
29677 * Note that <filename><gio/gwin32inputstream.h></filename> belongs
29678 * to the Windows-specific GIO interfaces, thus you have to use the
29679 * <filename>gio-windows-2.0.pc</filename> pkg-config file when using it.
29684 * g_bus_watch_name_on_connection_with_closures:
29685 * @connection: A #GDBusConnection.
29686 * @name: The name (well-known or unique) to watch.
29687 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
29688 * @name_appeared_closure: (allow-none): #GClosure to invoke when @name is known to exist or %NULL.
29689 * @name_vanished_closure: (allow-none): #GClosure to invoke when @name is known to not exist or %NULL.
29691 * Version of g_bus_watch_name_on_connection() using closures instead of callbacks for
29692 * easier binding in other languages.
29693 * g_bus_unwatch_name() to stop watching the name.
29695 * Returns: An identifier (never 0) that an be used with
29696 * Rename to: g_bus_watch_name_on_connection
29702 * g_file_mount_enclosing_volume:
29703 * @location: input #GFile.
29704 * @flags: flags affecting the operation
29705 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
29706 * @cancellable: optional #GCancellable object, %NULL to ignore.
29707 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
29708 * @user_data: the data to pass to callback function
29710 * Starts a @mount_operation, mounting the volume that contains the file @location.
29711 * When this operation has completed, @callback will be called with
29712 * g_file_mount_enclosing_volume_finish().
29713 * If @cancellable is not %NULL, then the operation can be cancelled by
29714 * triggering the cancellable object from another thread. If the operation
29715 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
29720 * G_PARAM_SPEC_BOXED:
29721 * @pspec: a valid #GParamSpec instance
29723 * Cast a #GParamSpec instance into a #GParamSpecBoxed.
29728 * GVolumeMonitor::mount-added:
29729 * @volume_monitor: The volume monitor emitting the signal.
29730 * @mount: a #GMount that was added.
29732 * Emitted when a mount is added.
29737 * GWin32OutputStream:
29739 * Implements #GOutputStream for outputting to Windows file handles
29745 * @class: a valid #GFlagsClass
29747 * Casts a derived #GFlagsClass structure into a #GFlagsClass structure.
29752 * G_IS_PARAM_SPEC_LONG:
29753 * @pspec: a valid #GParamSpec instance
29755 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG.
29757 * Returns: %TRUE on success.
29762 * g_settings_get_flags:
29763 * @settings: a #GSettings object
29764 * @key: the key to get the value for
29765 * @returns: the flags value
29767 * Gets the value that is stored in @settings for @key and converts it
29768 * to the flags value that it represents.
29769 * In order to use this function the type of the value must be an array
29770 * of strings and it must be marked in the schema file as an flags type.
29771 * It is a programmer error to give a @key that isn't contained in the
29772 * schema for @settings or is not marked as a flags type.
29773 * If the value stored in the configuration database is not a valid
29774 * value for the flags type then this function will return the default
29782 * g_file_info_get_attribute_stringv:
29783 * @info: a #GFileInfo.
29784 * @attribute: a file attribute key.
29786 * Gets the value of a stringv attribute. If the attribute does
29787 * not contain a stringv, %NULL will be returned.
29788 * %NULL otherwise. Do not free.
29790 * Returns: (transfer none): the contents of the @attribute value as a stringv, or
29798 * An abstract type that specifies an icon.
29805 * An object for Emblems
29810 * g_file_attribute_matcher_unref:
29811 * @matcher: a #GFileAttributeMatcher.
29813 * Unreferences @matcher. If the reference count falls below 1,
29814 * the @matcher is automatically freed.
29819 * g_proxy_address_new:
29820 * @inetaddr: The proxy server #GInetAddress.
29821 * @port: The proxy server port.
29822 * @protocol: The proxy protocol to support, in lower case (e.g. socks, http).
29823 * @dest_hostname: The destination hostname the the proxy should tunnel to.
29824 * @dest_port: The destination port to tunnel to.
29825 * @username: (allow-none): The username to authenticate to the proxy server (or %NULL).
29826 * @password: (allow-none): The password to authenticate to the proxy server (or %NULL).
29828 * Creates a new #GProxyAddress for @inetaddr with @protocol that should
29829 * tunnel through @dest_hostname and @dest_port.
29831 * Returns: a new #GProxyAddress
29837 * g_file_monitor_emit_event:
29838 * @monitor: a #GFileMonitor.
29839 * @child: a #GFile.
29840 * @other_file: a #GFile.
29841 * @event_type: a set of #GFileMonitorEvent flags.
29843 * Emits the #GFileMonitor::changed signal if a change
29844 * has taken place. Should be called from file monitor
29845 * implementations only.
29846 * The signal will be emitted from an idle handler (in the <link
29847 * linkend="g-main-context-push-thread-default">thread-default main
29853 * g_charset_converter_set_use_fallback:
29854 * @converter: a #GCharsetConverter
29855 * @use_fallback: %TRUE to use fallbacks
29857 * Sets the #GCharsetConverter:use-fallback property.
29864 * g_socket_receive_with_blocking:
29865 * @socket: a #GSocket
29866 * @buffer: a buffer to read data into (which should be at least @size bytes long).
29867 * @size: the number of bytes you want to read from the socket
29868 * @blocking: whether to do blocking or non-blocking I/O
29869 * @cancellable: (allow-none): a %GCancellable or %NULL
29870 * @error: #GError for error reporting, or %NULL to ignore.
29872 * This behaves exactly the same as g_socket_receive(), except that
29873 * the choice of blocking or non-blocking behavior is determined by
29874 * the @blocking argument rather than by @socket's properties.
29876 * Returns: Number of bytes read, or -1 on error
29882 * g_win32_input_stream_set_close_handle:
29883 * @stream: a #GWin32InputStream
29884 * @close_handle: %TRUE to close the handle when done
29886 * Sets whether the handle of @stream shall be closed
29887 * when the stream is closed.
29894 * g_node_insert_data:
29895 * @parent: the #GNode to place the new #GNode under
29896 * @position: the position to place the new #GNode at. If position is -1, the new #GNode is inserted as the last child of @parent
29897 * @data: the data for the new #GNode
29899 * Inserts a new #GNode at the given position.
29901 * Returns: the new #GNode
29906 * g_mount_get_name:
29907 * @mount: a #GMount.
29909 * Gets the name of @mount.
29910 * The returned string should be freed with g_free()
29911 * when no longer needed.
29913 * Returns: the name for the given @mount.
29918 * g_file_info_set_attribute_boolean:
29919 * @info: a #GFileInfo.
29920 * @attribute: a file attribute key.
29921 * @attr_value: a boolean value.
29923 * Sets the @attribute to contain the given @attr_value,
29929 * g_mount_eject_with_operation_finish:
29930 * @mount: a #GMount.
29931 * @result: a #GAsyncResult.
29932 * @error: a #GError location to store the error occuring, or %NULL to ignore.
29934 * Finishes ejecting a mount. If any errors occurred during the operation,
29936 * Returns: %TRUE if the mount was successfully ejected. %FALSE otherwise.
29942 * SECTION:giomodul:
29943 * @short_description: Loadable GIO Modules
29944 * @include: gio/gio.h
29946 * Provides an interface and default functions for loading and unloading
29947 * modules. This is used internally to make GIO extensible, but can also
29948 * be used by others to implement module loading.
29954 * @bus_type: A #GBusType.
29955 * @cancellable: A #GCancellable or %NULL.
29956 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
29957 * @user_data: The data to pass to @callback.
29959 * Asynchronously connects to the message bus specified by @bus_type.
29960 * When the operation is finished, @callback will be invoked. You can
29961 * then call g_bus_get_finish() to get the result of the operation.
29962 * This is a asynchronous failable function. See g_bus_get_sync() for
29963 * the synchronous version.
29970 * GInetAddress:is-mc-site-local:
29972 * Whether this is a site-local multicast address.
29973 * See g_inet_address_get_is_mc_site_local().
29980 * g_dbus_method_invocation_get_sender:
29981 * @invocation: A #GDBusMethodInvocation.
29983 * Gets the bus name that invoked the method.
29985 * Returns: A string. Do not free, it is owned by @invocation.
29991 * g_credentials_is_same_user:
29992 * @credentials: A #GCredentials.
29993 * @other_credentials: A #GCredentials.
29994 * @error: Return location for error or %NULL.
29996 * Checks if @credentials and @other_credentials is the same user.
29997 * This operation can fail if #GCredentials is not supported on the
29999 * user, %FALSE otherwise or if @error is set.
30001 * Returns: %TRUE if @credentials and @other_credentials has the same
30007 * g_data_output_stream_put_uint16:
30008 * @stream: a #GDataOutputStream.
30009 * @data: a #guint16.
30010 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
30011 * @error: a #GError, %NULL to ignore.
30013 * Puts an unsigned 16-bit integer into the output stream.
30015 * Returns: %TRUE if @data was successfully added to the @stream.
30020 * g_dbus_connection_send_message:
30021 * @connection: A #GDBusConnection.
30022 * @message: A #GDBusMessage
30023 * @flags: Flags affecting how the message is sent.
30024 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
30025 * @error: Return location for error or %NULL.
30027 * Asynchronously sends @message to the peer represented by @connection.
30028 * Unless @flags contain the
30029 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
30030 * will be assigned by @connection and set on @message via
30031 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
30032 * serial number used will be written to this location prior to
30033 * submitting the message to the underlying transport.
30034 * If @connection is closed then the operation will fail with
30035 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
30036 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
30037 * See <xref linkend="gdbus-server"/> and <xref
30038 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
30039 * low-level API to send and receive UNIX file descriptors.
30040 * Note that @message must be unlocked, unless @flags contain the
30041 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
30042 * transmission, %FALSE if @error is set.
30044 * Returns: %TRUE if the message was well-formed and queued for
30050 * G_FILE_ATTRIBUTE_UNIX_GID:
30052 * A key in the "unix" namespace for getting the group ID for the file.
30053 * This attribute is only available for UNIX file systems.
30054 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
30059 * g_main_is_running:
30060 * @loop: a #GMainLoop
30062 * Checks if the main loop is running.
30064 * Returns: %TRUE if the main loop is running
30065 * Deprecated: 2.2: Use g_main_loop_is_running() instead
30071 * @icon1: pointer to the first #GIcon.
30072 * @icon2: pointer to the second #GIcon.
30074 * Checks if two icons are equal.
30076 * Returns: %TRUE if @icon1 is equal to @icon2. %FALSE otherwise.
30081 * g_volume_should_automount:
30082 * @volume: a #GVolume
30084 * Returns whether the volume should be automatically mounted.
30086 * Returns: %TRUE if the volume should be automatically mounted.
30092 * @seekable: a #GSeekable.
30094 * Tells the current position within the stream.
30096 * Returns: the offset from the beginning of the buffer.
30101 * SECTION:gsimpleactio:
30102 * @title: GSimpleAction
30103 * @short_description: A simple GSimpleAction
30105 * A #GSimpleAction is the obvious simple implementation of the #GSimpleAction
30106 * interface. This is the easiest way to create an action for purposes of
30107 * adding it to a #GSimpleActionGroup.
30108 * See also #GtkAction.
30113 * g_socket_listener_add_inet_port:
30114 * @listener: a #GSocketListener
30115 * @port: an IP port number (non-zero)
30116 * @source_object: (allow-none): Optional #GObject identifying this source
30117 * @error: #GError for error reporting, or %NULL to ignore.
30119 * Helper function for g_socket_listener_add_address() that
30120 * creates a TCP/IP socket listening on IPv4 and IPv6 (if
30121 * supported) on the specified port on all interfaces.
30122 * to accept to identify this particular source, which is
30123 * useful if you're listening on multiple addresses and do
30124 * different things depending on what address is connected to.
30126 * Returns: %TRUE on success, %FALSE on error.
30132 * G_VARIANT_TYPE_TUPLE:
30134 * An indefinite type that is a supertype of every tuple type,
30135 * regardless of the number of items in the tuple.
30140 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT:
30142 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable.
30143 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
30148 * g_tls_client_connection_get_accepted_cas:
30149 * @conn: the #GTlsClientConnection
30151 * Gets the list of distinguished names of the Certificate Authorities
30152 * that the server will accept certificates from. This will be set
30153 * during the TLS handshake if the server requests a certificate.
30154 * Otherwise, it will be %NULL.
30155 * Each item in the list is a #GByteArray which contains the complete
30156 * subject DN of the certificate authority.
30157 * CA DNs. You should unref each element with g_byte_array_unref() and then
30158 * the free the list with g_list_free().
30160 * Returns: (element-type GByteArray) (transfer full): the list of
30166 * g_dbus_connection_call_finish:
30167 * @connection: A #GDBusConnection.
30168 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
30169 * @error: Return location for error or %NULL.
30171 * Finishes an operation started with g_dbus_connection_call().
30172 * return values. Free with g_variant_unref().
30174 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
30180 * g_proxy_resolver_lookup_async:
30181 * @resolver: a #GProxyResolver
30182 * @uri: a URI representing the destination to connect to
30183 * @cancellable: (allow-none): a #GCancellable, or %NULL
30184 * @callback: (scope async): callback to call after resolution completes
30185 * @user_data: (closure): data for @callback
30187 * Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more
30195 * G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC:
30197 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE)
30198 * is automatically polled for media.
30199 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
30206 * g_node_prev_sibling:
30209 * Gets the previous sibling of a #GNode.
30212 * Returns: the previous sibling of @node, or %NULL if @node is the first
30217 * G_IS_PARAM_SPEC_BOOLEAN:
30218 * @pspec: a valid #GParamSpec instance
30220 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN.
30222 * Returns: %TRUE on success.
30227 * G_FILE_ATTRIBUTE_FILESYSTEM_SIZE:
30229 * A key in the "filesystem" namespace for getting the total size (in bytes) of the file system,
30230 * used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType
30231 * is %G_FILE_ATTRIBUTE_TYPE_UINT64.
30236 * SECTION:gsetting:
30237 * @short_description: High-level API for application settings
30239 * The #GSettings class provides a convenient API for storing and retrieving
30240 * application settings.
30241 * When creating a GSettings instance, you have to specify a schema
30242 * that describes the keys in your settings and their types and default
30243 * values, as well as some other information.
30244 * Normally, a schema has as fixed path that determines where the settings
30245 * are stored in the conceptual global tree of settings. However, schemas
30246 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
30247 * useful e.g. when the schema describes an 'account', and you want to be
30248 * able to store a arbitrary number of accounts.
30249 * Unlike other configuration systems (like GConf), GSettings does not
30250 * restrict keys to basic types like strings and numbers. GSettings stores
30251 * values as #GVariant, and allows any #GVariantType for keys. Key names
30252 * are restricted to lowercase characters, numbers and '-'. Furthermore,
30253 * the names must begin with a lowercase character, must not end
30254 * with a '-', and must not contain consecutive dashes. Key names can
30255 * be up to 32 characters long.
30256 * Similar to GConf, the default values in GSettings schemas can be
30257 * localized, but the localized values are stored in gettext catalogs
30258 * and looked up with the domain that is specified in the
30259 * <tag class="attribute">gettext-domain</tag> attribute of the
30260 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
30261 * elements and the category that is specified in the l10n attribute of the
30262 * <tag class="starttag">key</tag> element.
30263 * GSettings uses schemas in a compact binary form that is created
30264 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
30265 * utility. The input is a schema description in an XML format that can be
30266 * described by the following DTD:
30267 * |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gschema.dtd"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]|
30268 * At runtime, schemas are identified by their id (as specified
30269 * in the <tag class="attribute">id</tag> attribute of the
30270 * <tag class="starttag">schema</tag> element). The
30271 * convention for schema ids is to use a dotted name, similar in
30272 * style to a DBus bus name, e.g. "org.gnome.font-rendering".
30273 * In addition to #GVariant types, keys can have types that have enumerated
30274 * types. These can be described by a <tag class="starttag">choice</tag>,
30275 * <tag class="starttag">enum</tag> or <tag class="starttag">flags</tag> element, see
30276 * <xref linkend="schema-enumerated"/>. The underlying type of
30277 * such a key is string, but you can use g_settings_get_enum(),
30278 * g_settings_set_enum(), g_settings_get_flags(), g_settings_set_flags()
30279 * access the numeric values corresponding to the string value of enum
30281 * <example id="schema-default-values"><title>Default values</title>
30282 * <programlisting><![CDATA[
30284 * <schema id="org.gtk.test" path="/tests/" gettext-domain="test">
30285 * <key name="greeting" type="s">
30286 * <default l10n="messages">"Hello, earthlings"</default>
30287 * <summary>A greeting</summary>
30289 * Greeting of the invading martians
30292 * <key name="box" type="(ii)">
30293 * <default>(20,30)</default>
30297 * ]]></programlisting></example>
30298 * <example id="schema-enumerated"><title>Ranges, choices and enumerated types</title>
30299 * <programlisting><![CDATA[
30301 * <enum id="myenum">
30302 * <value nick="first" value="1"/>
30303 * <value nick="second" value="2"/>
30305 * <enum id="myflags">
30306 * <value nick="flag1" value="1"/>
30307 * <value nick="flag2" value="2"/>
30308 * <value nick="flag3" value="4"/>
30310 * <schema id="org.gtk.test">
30311 * <key name="key-with-range" type="i">
30312 * <range min="1" max="100"/>
30313 * <default>10</default>
30315 * <key name="key-with-choices" type="s">
30317 * <choice value='Elisabeth'/>
30318 * <choice value='Annabeth'/>
30319 * <choice value='Joe'/>
30322 * <alias value='Anna' target='Annabeth'/>
30323 * <alias value='Beth' target='Elisabeth'/>
30325 * <default>'Joe'</default>
30327 * <key name='enumerated-key' enum='myenum'>
30328 * <default>'first'</default>
30330 * <key name='flags-key' flags='myflags'>
30331 * <default>["flag1",flag2"]</default>
30335 * ]]></programlisting></example>
30337 * <title>Vendor overrides</title>
30339 * Default values are defined in the schemas that get installed by
30340 * an application. Sometimes, it is necessary for a vendor or distributor
30341 * to adjust these defaults. Since patching the XML source for the schema
30342 * is inconvenient and error-prone,
30343 * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
30344 * so-called 'vendor override' files. These are keyfiles in the same
30345 * directory as the XML schema sources which can override default values.
30346 * The schema id serves as the group name in the key file, and the values
30347 * are expected in serialized GVariant form, as in the following example:
30348 * <informalexample><programlisting>
30349 * [org.gtk.Example]
30352 * </programlisting></informalexample>
30356 * <title>Binding</title>
30358 * A very convenient feature of GSettings lets you bind #GObject properties
30359 * directly to settings, using g_settings_bind(). Once a GObject property
30360 * has been bound to a setting, changes on either side are automatically
30361 * propagated to the other side. GSettings handles details like
30362 * mapping between GObject and GVariant types, and preventing infinite
30366 * This makes it very easy to hook up a preferences dialog to the
30367 * underlying settings. To make this even more convenient, GSettings
30368 * looks for a boolean property with the name "sensitivity" and
30369 * automatically binds it to the writability of the bound setting.
30370 * If this 'magic' gets in the way, it can be suppressed with the
30371 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
30378 * g_volume_enumerate_identifiers:
30379 * @volume: a #GVolume
30381 * Gets the kinds of <link linkend="volume-identifier">identifiers</link>
30382 * that @volume has. Use g_volume_get_identifer() to obtain
30383 * the identifiers themselves.
30384 * of strings containing kinds of identifiers. Use g_strfreev() to free.
30386 * Returns: (array zero-terminated=1) (transfer full): a %NULL-terminated array
30391 * g_zlib_decompressor_get_file_info:
30392 * @decompressor: a #GZlibDecompressor
30394 * Retrieves the #GFileInfo constructed from the GZIP header data
30395 * of compressed data processed by @compressor, or %NULL if @decompressor's
30396 * #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
30397 * or the header data was not fully processed yet, or it not present in the
30398 * data stream at all.
30400 * Returns: (transfer none): a #GFileInfo, or %NULL
30406 * SECTION:ginputstrea:
30407 * @short_description: Base class for implementing streaming input
30408 * @include: gio/gio.h
30410 * GInputStream has functions to read from a stream (g_input_stream_read()),
30411 * to close a stream (g_input_stream_close()) and to skip some content
30412 * (g_input_stream_skip()).
30413 * To copy the content of an input stream to an output stream without
30414 * manually handling the reads and writes, use g_output_stream_splice().
30415 * All of these functions have async variants too.
30420 * g_permission_impl_update:
30421 * @permission: a #GPermission instance
30422 * @allowed: the new value for the 'allowed' property
30423 * @can_acquire: the new value for the 'can-acquire' property
30424 * @can_release: the new value for the 'can-release' property
30426 * This function is called by the #GPermission implementation to update
30427 * the properties of the permission. You should never call this
30428 * function except from a #GPermission implementation.
30429 * GObject notify signals are generated, as appropriate.
30436 * GAsyncReadyCallback:
30437 * @source_object: the object the asynchronous operation was started with.
30438 * @res: a #GAsyncResult.
30439 * @user_data: user data passed to the callback.
30441 * Type definition for a function that will be called back when an asynchronous
30442 * operation within GIO has been completed.
30447 * g_dbus_method_invocation_return_gerror:
30448 * @invocation: A #GDBusMethodInvocation.
30449 * @error: A #GError.
30451 * Like g_dbus_method_invocation_return_error() but takes a #GError
30452 * instead of the error domain, error code and message.
30453 * This method will free @invocation, you cannot use it afterwards.
30460 * g_settings_list_children:
30461 * @settings: a #GSettings object
30462 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
30464 * Gets the list of children on @settings.
30465 * The list is exactly the list of strings for which it is not an error
30466 * to call g_settings_get_child().
30467 * For GSettings objects that are lists, this value can change at any
30468 * time and you should connect to the "children-changed" signal to watch
30469 * request a child after listing it only for it to have been destroyed
30470 * in the meantime. For this reason, g_settings_get_child() may return
30471 * %NULL even for a child that was listed by this function.
30472 * For GSettings objects that are not lists, you should probably not be
30473 * calling this function from "normal" code (since you should already
30474 * know what children are in your schema). This function may still be
30475 * useful there for introspection reasons, however.
30476 * You should free the return value with g_strfreev() when you are done
30479 * For those changes. note that there is a race condition here: you may
30484 * g_app_launch_context_get_startup_notify_id:
30485 * @context: a #GAppLaunchContext
30486 * @info: a #GAppInfo
30487 * @files: (element-type GFile): a #GList of of #GFile objects
30489 * Initiates startup notification for the application and returns the
30490 * <envar>DESKTOP_STARTUP_ID</envar> for the launched operation,
30492 * Startup notification IDs are defined in the <ulink
30493 * url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
30494 * FreeDesktop.Org Startup Notifications standard</ulink>.
30497 * Returns: a startup notification ID for the application, or %NULL if
30502 * g_dbus_address_get_stream_finish:
30503 * @res: A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream().
30504 * @out_guid: %NULL or return location to store the GUID extracted from @address, if any.
30505 * @error: Return location for error or %NULL.
30507 * Finishes an operation started with g_dbus_address_get_stream().
30509 * Returns: (transfer full): A #GIOStream or %NULL if @error is set.
30515 * G_TYPE_BYTE_ARRAY:
30517 * The #GType for a boxed type holding a #GByteArray reference.
30524 * g_file_set_attribute_string:
30525 * @file: input #GFile.
30526 * @attribute: a string containing the attribute's name.
30527 * @value: a string containing the attribute's value.
30528 * @flags: #GFileQueryInfoFlags.
30529 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
30530 * @error: a #GError, or %NULL
30532 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
30533 * If @attribute is of a different type, this operation will fail.
30534 * If @cancellable is not %NULL, then the operation can be cancelled by
30535 * triggering the cancellable object from another thread. If the operation
30536 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
30538 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
30543 * g_file_read_finish:
30544 * @file: input #GFile.
30545 * @res: a #GAsyncResult.
30546 * @error: a #GError, or %NULL
30548 * Finishes an asynchronous file read operation started with
30549 * g_file_read_async().
30550 * Free the returned object with g_object_unref().
30552 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
30557 * g_socket_client_connect_to_uri_finish:
30558 * @client: a #GSocketClient.
30559 * @result: a #GAsyncResult.
30560 * @error: a #GError location to store the error occuring, or %NULL to ignore.
30562 * Finishes an async connect operation. See g_socket_client_connect_to_uri_async()
30564 * Returns: (transfer full): a #GSocketConnection on success, %NULL on error.
30571 * @type: A #GType value.
30573 * Checks whether the passed in type ID can be used for g_value_init().
30574 * That is, this macro checks whether this type provides an implementation
30575 * of the #GTypeValueTable functions required for a type to create a #GValue of.
30577 * Returns: Whether @type is suitable as a #GValue type.
30582 * g_file_load_contents_async:
30583 * @file: input #GFile.
30584 * @cancellable: optional #GCancellable object, %NULL to ignore.
30585 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
30586 * @user_data: the data to pass to callback function
30588 * Starts an asynchronous load of the @file's contents.
30589 * For more details, see g_file_load_contents() which is
30590 * the synchronous version of this call.
30591 * When the load operation has completed, @callback will be called
30592 * with @user data. To finish the operation, call
30593 * g_file_load_contents_finish() with the #GAsyncResult returned by
30595 * If @cancellable is not %NULL, then the operation can be cancelled by
30596 * triggering the cancellable object from another thread. If the operation
30597 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
30602 * g_dbus_connection_call_sync:
30603 * @connection: A #GDBusConnection.
30604 * @bus_name: A unique or well-known bus name.
30605 * @object_path: Path of remote object.
30606 * @interface_name: D-Bus interface to invoke method on.
30607 * @method_name: The name of the method to invoke.
30608 * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
30609 * @reply_type: The expected type of the reply, or %NULL.
30610 * @flags: Flags from the #GDBusCallFlags enumeration.
30611 * @timeout_msec: The timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout.
30612 * @cancellable: A #GCancellable or %NULL.
30613 * @error: Return location for error or %NULL.
30615 * Synchronously invokes the @method_name method on the
30616 * If @connection is closed then the operation will fail with
30617 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
30618 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
30619 * contains a value not compatible with the D-Bus protocol, the operation
30620 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
30621 * If @reply_type is non-%NULL then the reply will be checked for having
30622 * this type and an error will be raised if it does not match. Said
30623 * another way, if you give a @reply_type then any non-%NULL return
30624 * value will be of this type.
30625 * If the @parameters #GVariant is floating, it is consumed.
30626 * This allows convenient 'inline' use of g_variant_new(), e.g.:
30628 * g_dbus_connection_call_sync (connection,
30629 * "org.freedesktop.StringThings",
30630 * "/org/freedesktop/StringThings",
30631 * "org.freedesktop.StringThings",
30633 * g_variant_new ("(ss)",
30637 * G_DBUS_CALL_FLAGS_NONE,
30642 * The calling thread is blocked until a reply is received. See
30643 * g_dbus_connection_call() for the asynchronous version of
30645 * return values. Free with g_variant_unref().
30647 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
30653 * g_output_stream_write_all:
30654 * @stream: a #GOutputStream.
30655 * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write.
30656 * @count: the number of bytes to write
30657 * @bytes_written: (out): location to store the number of bytes that was written to the stream
30658 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
30659 * @error: location to store the error occuring, or %NULL to ignore
30661 * Tries to write @count bytes from @buffer into the stream. Will block
30662 * during the operation.
30663 * This function is similar to g_output_stream_write(), except it tries to
30664 * write as many bytes as requested, only stopping on an error.
30665 * On a successful write of @count bytes, %TRUE is returned, and @bytes_written
30666 * is set to @count.
30667 * If there is an error during the operation FALSE is returned and @error
30668 * is set to indicate the error status, @bytes_written is updated to contain
30669 * the number of bytes written into the stream before the error occurred.
30671 * Returns: %TRUE on success, %FALSE if there was an error
30676 * G_TYPE_PARAM_BOXED:
30678 * The #GType of #GParamSpecBoxed.
30683 * g_file_monitor_file:
30684 * @file: input #GFile.
30685 * @flags: a set of #GFileMonitorFlags.
30686 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
30687 * @error: a #GError, or %NULL.
30689 * Obtains a file monitor for the given file. If no file notification
30690 * mechanism exists, then regular polling of the file is used.
30691 * If @cancellable is not %NULL, then the operation can be cancelled by
30692 * triggering the cancellable object from another thread. If the operation
30693 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
30694 * Free the returned object with g_object_unref().
30696 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
30701 * SECTION:gapplicationcommandlin:
30702 * @title: GApplicationCommandLine
30703 * @short_description: A command-line invocation of an application
30704 * @see_also: #GApplication
30706 * #GApplicationCommandLine represents a command-line invocation of
30707 * an application. It is created by #GApplication and emitted
30708 * in the #GApplication::command-line signal and virtual function.
30709 * The class contains the list of arguments that the program was invoked
30710 * with. It is also possible to query if the commandline invocation was
30711 * commandline to this process).
30712 * The exit status of the originally-invoked process may be set and
30713 * messages can be printed to stdout or stderr of that process. The
30714 * lifecycle of the originally-invoked process is tied to the lifecycle
30716 * <example id="gapplication-example-cmdline"><title>Handling commandline arguments with GApplication</title>
30718 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-cmdline.c">
30719 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
30721 * </programlisting>
30723 * <example id="gapplication-example-cmdline2"><title>Complicated commandline handling</title>
30725 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-cmdline2.c">
30726 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
30728 * </programlisting>
30731 * Local (ie: the current process is running in direct response to the
30732 * Invocation) or remote (ie: some other process forwarded the
30733 * Of this object (ie: the process exits when the last reference is
30738 * g_async_initable_new_finish:
30739 * @initable: the #GAsyncInitable from the callback
30740 * @res: the #GAsyncResult.from the callback
30741 * @error: a #GError location to store the error occuring, or %NULL to ignore.
30743 * Finishes the async construction for the various g_async_initable_new calls,
30744 * returning the created object or %NULL on error.
30745 * g_object_unref().
30747 * Returns: (transfer full): a newly created #GObject, or %NULL on error. Free with
30753 * g_pollable_input_stream_create_source: (skip)
30754 * @stream: a #GPollableInputStream.
30755 * @cancellable: (allow-none): a #GCancellable, or %NULL
30757 * Creates a #GSource that triggers when @stream can be read, or
30758 * source is of the #GPollableSourceFunc type.
30759 * As with g_pollable_input_stream_is_readable(), it is possible that
30760 * the stream may not actually be readable even after the source
30761 * triggers, so you should use g_pollable_input_stream_read_nonblocking()
30762 * rather than g_input_stream_read() from the callback.
30764 * Returns: (transfer full): a new #GSource
30770 * g_file_supports_thread_contexts:
30773 * Checks if @file supports <link
30774 * linkend="g-main-context-push-thread-default-context">thread-default
30775 * contexts</link>. If this returns %FALSE, you cannot perform
30776 * asynchronous operations on @file in a thread that has a
30777 * thread-default context.
30779 * Returns: Whether or not @file supports thread-default contexts.
30786 * @source: #GFile pointing to the source location.
30787 * @destination: #GFile pointing to the destination location.
30788 * @flags: set of #GFileCopyFlags.
30789 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
30790 * @progress_callback: (scope call): #GFileProgressCallback function for updates.
30791 * @progress_callback_data: (closure): gpointer to user data for the callback function.
30792 * @error: #GError for returning error conditions, or %NULL
30794 * Tries to move the file or directory @source to the location specified by @destination.
30795 * If native move operations are supported then this is used, otherwise a copy + delete
30796 * fallback is used. The native implementation may support moving directories (for instance
30797 * on moves inside the same filesystem), but the fallback code does not.
30798 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
30799 * existing @destination file is overwritten.
30800 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
30801 * will be copied as symlinks, otherwise the target of the
30802 * If @cancellable is not %NULL, then the operation can be cancelled by
30803 * triggering the cancellable object from another thread. If the operation
30804 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
30805 * If @progress_callback is not %NULL, then the operation can be monitored by
30806 * setting this to a #GFileProgressCallback function. @progress_callback_data
30807 * will be passed to this function. It is guaranteed that this callback will
30808 * be called after all data has been transferred with the total number of bytes
30809 * copied during the operation.
30810 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
30811 * error is returned, independent on the status of the @destination.
30812 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
30813 * error G_IO_ERROR_EXISTS is returned.
30814 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
30815 * error is returned. If trying to overwrite a directory with a directory the
30816 * G_IO_ERROR_WOULD_MERGE error is returned.
30817 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
30818 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
30819 * may be returned (if the native move operation isn't available).
30821 * Returns: %TRUE on successful move, %FALSE otherwise.
30826 * g_socket_connection_get_local_address:
30827 * @connection: a #GSocketConnection
30828 * @error: #GError for error reporting, or %NULL to ignore.
30830 * Try to get the local address of a socket connection.
30831 * Free the returned object with g_object_unref().
30833 * Returns: (transfer full): a #GSocketAddress or %NULL on error.
30839 * g_buffered_output_stream_new:
30840 * @base_stream: a #GOutputStream.
30842 * Creates a new buffered output stream for a base stream.
30844 * Returns: a #GOutputStream for the given @base_stream.
30849 * g_dbus_proxy_get_object_path:
30850 * @proxy: A #GDBusProxy.
30852 * Gets the object path @proxy is for.
30854 * Returns: A string owned by @proxy. Do not free.
30860 * G_TYPE_DBUS_ARG_INFO:
30862 * The #GType for a boxed type holding a #GDBusArgInfo.
30869 * g_unix_mount_point_is_readonly:
30870 * @mount_point: a #GUnixMountPoint.
30872 * Checks if a unix mount point is read only.
30874 * Returns: %TRUE if a mount point is read only.
30881 * The timeout in seconds on socket I/O
30888 * g_dbus_message_get_header:
30889 * @message: A #GDBusMessage.
30890 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
30892 * Gets a header field on @message.
30893 * otherwise. Do not free, it is owned by @message.
30895 * Returns: A #GVariant with the value if the header was found, %NULL
30901 * g_socket_receive_message:
30902 * @socket: a #GSocket
30903 * @address: a pointer to a #GSocketAddress pointer, or %NULL
30904 * @vectors: (array length=num_vectors): an array of #GInputVector structs
30905 * @num_vectors: the number of elements in @vectors, or -1
30906 * @messages: (array length=num_messages) (allow-none): a pointer which may be filled with an array of #GSocketControlMessages, or %NULL
30907 * @num_messages: a pointer which will be filled with the number of elements in @messages, or %NULL
30908 * @flags: a pointer to an int containing #GSocketMsgFlags flags
30909 * @cancellable: (allow-none): a %GCancellable or %NULL
30910 * @error: a #GError pointer, or %NULL
30912 * Receive data from a socket. This is the most complicated and
30913 * fully-featured version of this call. For easier use, see
30914 * g_socket_receive() and g_socket_receive_from().
30915 * If @address is non-%NULL then @address will be set equal to the
30916 * source address of the received packet.
30917 * describe the buffers that received data will be scattered into.
30918 * If @num_vectors is -1, then @vectors is assumed to be terminated
30919 * by a #GInputVector with a %NULL buffer pointer.
30920 * As a special case, if @num_vectors is 0 (in which case, @vectors
30921 * may of course be %NULL), then a single byte is received and
30922 * discarded. This is to facilitate the common practice of sending a
30923 * single '\0' byte for the purposes of transferring ancillary data.
30924 * array of #GSocketControlMessage instances or %NULL if no such
30925 * messages was received. These correspond to the control messages
30926 * received from the kernel, one #GSocketControlMessage per message
30927 * from the kernel. This array is %NULL-terminated and must be freed
30928 * by the caller using g_free() after calling g_object_unref() on each
30929 * element. If @messages is %NULL, any control messages received will
30931 * messages received.
30932 * If both @messages and @num_messages are non-%NULL, then
30933 * for this are available in the #GSocketMsgFlags enum, but the
30934 * values there are the same as the system values, and the flags
30935 * are passed in as-is, so you can pass in system-specific flags too
30936 * (and g_socket_receive_message() may pass system-specific flags out).
30937 * As with g_socket_receive(), data may be discarded if @socket is
30938 * %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not
30939 * provide enough buffer space to read a complete message. You can pass
30940 * %G_SOCKET_MSG_PEEK in @flags to peek at the current message without
30941 * removing it from the receive queue, but there is no portable way to find
30942 * out the length of the message other than by reading it into a
30943 * sufficiently-large buffer.
30944 * If the socket is in blocking mode the call will block until there
30945 * is some data to receive or there is an error. If there is no data
30946 * available and the socket is in non-blocking mode, a
30947 * %G_IO_ERROR_WOULD_BLOCK error will be returned. To be notified when
30948 * data is available, wait for the %G_IO_IN condition.
30949 * On error -1 is returned and @error is set accordingly.
30951 * In @messages (ie: not including the %NULL terminator).
30952 * Returns: Number of bytes read, or -1 on error
30958 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP:
30960 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped.
30961 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
30968 * g_inet_address_get_is_mc_site_local:
30969 * @address: a #GInetAddress
30971 * Tests whether @address is a site-local multicast address.
30973 * Returns: %TRUE if @address is a site-local multicast address.
30979 * G_TYPE_RESERVED_USER_FIRST:
30981 * First available fundamental type number to create new fundamental
30982 * type id with G_TYPE_MAKE_FUNDAMENTAL().
30987 * SECTION:gtlsbacken:
30988 * @title: GTlsBackend
30989 * @short_description: TLS backend implementation
30990 * @include: gio/gio.h
30997 * GRegexCompileFlags:
30998 * @G_REGEX_CASELESS: Letters in the pattern match both upper- and lowercase letters. This option can be changed within a pattern by a "(?i)" option setting.
30999 * @G_REGEX_MULTILINE: 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 ("$") matches only at the end of the string, or before a terminating newline (unless #G_REGEX_DOLLAR_ENDONLY is set). When #G_REGEX_MULTILINE is set, the "start of line" and "end of line" constructs match immediately following or immediately before any newline in the string, respectively, as well as at the very start and end. This can be changed within a pattern by a "(?m)" option setting.
31000 * @G_REGEX_DOTALL: A dot metacharater (".") 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.
31001 * @G_REGEX_EXTENDED: 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 the next newline character, inclusive, are also ignored. This can be changed within a pattern by a "(?x)" option setting.
31002 * @G_REGEX_ANCHORED: 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 "^" metacharater.
31003 * @G_REGEX_DOLLAR_ENDONLY: 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.
31004 * @G_REGEX_UNGREEDY: 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.
31005 * @G_REGEX_RAW: Usually strings must be valid UTF-8 strings, using this flag they are considered as a raw sequence of bytes.
31006 * @G_REGEX_NO_AUTO_CAPTURE: 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).
31007 * @G_REGEX_OPTIMIZE: 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.
31008 * @G_REGEX_DUPNAMES: 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.
31009 * @G_REGEX_NEWLINE_CR: Usually any newline character is recognized, if this option is set, the only recognized newline character is '\r'.
31010 * @G_REGEX_NEWLINE_LF: Usually any newline character is recognized, if this option is set, the only recognized newline character is '\n'.
31011 * @G_REGEX_NEWLINE_CRLF: Usually any newline character is recognized, if this option is set, the only recognized newline character sequence is '\r\n'.
31013 * Flags specifying compile-time options.
31020 * g_io_modules_scan_all_in_directory:
31021 * @dirname: pathname for a directory containing modules to scan.
31023 * Scans all the modules in the specified directory, ensuring that
31024 * any extension point implemented by a module is registered.
31025 * This may not actually load and initialize all the types in each
31026 * module, some modules may be lazily loaded and initialized when
31027 * an extension point it implementes is used with e.g.
31028 * g_io_extension_point_get_extensions() or
31029 * g_io_extension_point_get_extension_by_name().
31030 * If you need to guarantee that all types are loaded in all the modules,
31031 * use g_io_modules_load_all_in_directory().
31038 * g_socket_service_stop:
31039 * @service: a #GSocketService
31041 * Stops the service, i.e. stops accepting connections
31042 * from the added sockets when the mainloop runs.
31043 * This call is threadsafe, so it may be called from a thread
31044 * handling an incomming client request.
31051 * G_FLAGS_CLASS_TYPE:
31052 * @class: a #GFlagsClass
31054 * Get the type identifier from a given #GFlagsClass structure.
31056 * Returns: the #GType
31061 * g_settings_new_with_backend_and_path:
31062 * @schema: the name of the schema
31063 * @backend: the #GSettingsBackend to use
31064 * @path: the path to use
31065 * @returns: a new #GSettings object
31067 * Creates a new #GSettings object with a given schema, backend and
31069 * This is a mix of g_settings_new_with_backend() and
31070 * g_settings_new_with_path().
31077 * g_bus_own_name_with_closures:
31078 * @bus_type: The type of bus to own a name on.
31079 * @name: The well-known name to own.
31080 * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
31081 * @bus_acquired_closure: (allow-none): #GClosure to invoke when connected to the bus of type @bus_type or %NULL.
31082 * @name_acquired_closure: (allow-none): #GClosure to invoke when @name is acquired or %NULL.
31083 * @name_lost_closure: (allow-none): #GClosure to invoke when @name is lost or %NULL.
31085 * Version of g_bus_own_name() using closures instead of callbacks for
31086 * easier binding in other languages.
31087 * g_bus_unown_name() to stop owning the name.
31089 * Returns: An identifier (never 0) that an be used with
31090 * Rename to: g_bus_own_name
31099 * Checks if the VFS is active.
31101 * Returns: %TRUE if construction of the @vfs was successful and it is now active.
31106 * g_settings_set_int:
31107 * @settings: a #GSettings object
31108 * @key: the name of the key to set
31109 * @value: the value to set it to
31110 * @returns: %TRUE if setting the key succeeded, %FALSE if the key was not writable
31112 * Sets @key in @settings to @value.
31113 * A convenience variant of g_settings_set() for 32-bit integers.
31114 * It is a programmer error to give a @key that isn't specified as
31115 * having a int32 type in the schema for @settings.
31124 * The fundamental type corresponding to #gdouble.
31129 * G_VARIANT_TYPE_UINT64:
31131 * The type of an integer value that can range from 0 to
31132 * 18446744073709551616. That's a really big number, but a Rubik's
31133 * cube can have a bit more than twice as many possible positions.
31138 * g_file_replace_contents_finish:
31139 * @file: input #GFile.
31140 * @res: a #GAsyncResult.
31141 * @new_etag: (out) (allow-none): a location of a new <link linkend="gfile-etag">entity tag</link> for the document. This should be freed with g_free() when it is no longer needed, or %NULL
31142 * @error: a #GError, or %NULL
31144 * Finishes an asynchronous replace of the given @file. See
31145 * g_file_replace_contents_async(). Sets @new_etag to the new entity
31146 * tag for the document, if present.
31148 * Returns: %TRUE on success, %FALSE on failure.
31153 * GDBusConnectionClass:
31154 * @closed: Signal class handler for the #GDBusConnection::closed signal.
31156 * Class structure for #GDBusConnection.
31163 * G_TYPE_RESERVED_GLIB_FIRST:
31165 * First fundamental type number to create a new fundamental type id with
31166 * G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib.
31172 * @parent_instance: private #GParamSpec portion
31173 * @minimum: minimum value for the property specified
31174 * @maximum: maximum value for the property specified
31175 * @default_value: default value for the property specified
31177 * A #GParamSpec derived structure that contains the meta data for unsigned character properties.
31182 * g_network_address_parse_uri:
31183 * @uri: the hostname and optionally a port
31184 * @default_port: The default port if none is found in the URI
31185 * @error: a pointer to a #GError, or %NULL
31187 * Creates a new #GSocketConnectable for connecting to the given
31188 * Using this rather than g_network_address_new() or
31189 * g_network_address_parse_host() allows #GSocketClient to determine
31190 * when to use application-specific proxy protocols.
31192 * Returns: (transfer full): the new #GNetworkAddress, or %NULL on error
31198 * g_inet_address_get_is_mc_org_local:
31199 * @address: a #GInetAddress
31201 * Tests whether @address is an organization-local multicast address.
31203 * Returns: %TRUE if @address is an organization-local multicast address.
31209 * g_keyfile_settings_backend_new:
31210 * @filename: the filename of the keyfile
31211 * @root_path: the path under which all settings keys appear
31212 * @root_group: (allow-none): the group name corresponding to
31213 * @returns: (transfer full): a keyfile-backed #GSettingsBackend
31215 * Creates a keyfile-backed #GSettingsBackend.
31216 * The filename of the keyfile to use is given by @filename.
31217 * All settings read to or written from the backend must fall under the
31218 * path given in @root_path (which must start and end with a slash and
31219 * not contain two consecutive slashes). @root_path may be "/".
31220 * If @root_group is non-%NULL then it specifies the name of the keyfile
31221 * group used for keys that are written directly below @root_path. For
31222 * example, if @root_path is "/apps/example/" and @root_group is
31223 * "toplevel", then settings the key "/apps/example/enabled" to a value
31224 * of %TRUE will cause the following to appear in the keyfile:
31229 * If @root_group is %NULL then it is not permitted to store keys
31230 * directly below the @root_path.
31231 * the name of the subpath (with the final slash stripped) is used as
31232 * the name of the keyfile group. To continue the example, if
31233 * "/apps/example/profiles/default/font-size" were set to
31234 * 12 then the following would appear in the keyfile:
31236 * [profiles/default]
31239 * The backend will refuse writes (and return writability as being
31240 * %FALSE) for keys outside of @root_path and, in the event that
31241 * Writes will also be refused if the backend detects that it has the
31243 * There is no checking done for your key namespace clashing with the
31244 * syntax of the key file format. For example, if you have '[' or ']'
31245 * characters in your path names or '=' in your key names you may be in
31248 * For keys not stored directly below @root_path (ie: in a sub-path),
31249 * Inability to rewrite the keyfile (ie: the containing directory is not
31254 * G_OBJECT_CLASS_NAME:
31255 * @class: a valid #GObjectClass
31257 * Return the name of a class structure's type.
31258 * should not be freed.
31260 * Returns: Type name of @class. The string is owned by the type system and
31267 * Implementation of the #GMount interface for Unix systems.
31272 * g_socket_client_add_application_proxy:
31273 * @client: a #GSocketClient
31274 * @protocol: The proxy protocol
31276 * Enable proxy protocols to be handled by the application. When the
31277 * indicated proxy protocol is returned by the #GProxyResolver,
31278 * #GSocketClient will consider this protocol as supported but will
31279 * not try find a #GProxy instance to handle handshaking. The
31280 * application must check for this case by calling
31281 * g_socket_connection_get_remote_address() on the returned
31282 * #GSocketConnection, and seeing if it's a #GProxyAddress of the
31283 * appropriate type, to determine whether or not it needs to handle
31284 * the proxy handshaking itself.
31285 * This should be used for proxy protocols that are dialects of
31286 * another protocol such as HTTP proxy. It also allows cohabitation of
31287 * proxy protocols that are reused between protocols. A good example
31288 * is HTTP. It can be used to proxy HTTP, FTP and Gopher and can also
31289 * be use as generic socket proxy through the HTTP CONNECT method.
31295 * @drive: a #GDrive.
31296 * @flags: flags affecting the unmount if required for stopping.
31297 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
31298 * @cancellable: optional #GCancellable object, %NULL to ignore.
31299 * @callback: a #GAsyncReadyCallback, or %NULL.
31300 * @user_data: user data to pass to @callback
31302 * Asynchronously stops a drive.
31303 * When the operation is finished, @callback will be called.
31304 * You can then call g_drive_stop_finish() to obtain the
31305 * result of the operation.
31312 * GFileDescriptorBased:
31314 * An interface for file descriptor based io objects.
31319 * g_memory_output_stream_get_data_size:
31320 * @ostream: a #GMemoryOutputStream
31322 * Returns the number of bytes from the start up
31323 * to including the last byte written in the stream
31324 * that has not been truncated away.
31326 * Returns: the number of bytes written to the stream
31332 * GTypePluginUnuse:
31333 * @plugin: the #GTypePlugin whose use count should be decreased
31335 * The type of the @unuse_plugin function of #GTypePluginClass.
31340 * g_file_info_get_is_symlink:
31341 * @info: a #GFileInfo.
31343 * Checks if a file is a symlink.
31345 * Returns: %TRUE if the given @info is a symlink.
31350 * G_PARAM_SPEC_VALUE_TYPE:
31351 * @pspec: a valid #GParamSpec
31353 * Retrieves the #GType to initialize a #GValue for this parameter.
31358 * GDataInputStream:
31360 * An implementation of #GBufferedInputStream that allows for high-level
31361 * data manipulation of arbitrary data (including binary operations).
31366 * g_dbus_message_set_path:
31367 * @message: A #GDBusMessage.
31368 * @value: The value to set.
31370 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
31377 * g_io_stream_set_pending:
31378 * @stream: a #GIOStream
31379 * @error: a #GError location to store the error occuring, or %NULL to ignore
31381 * Sets @stream to have actions pending. If the pending flag is
31382 * already set or @stream is closed, it will return %FALSE and set
31384 * Returns: %TRUE if pending was previously unset and is now set.
31390 * g_socket_service_start:
31391 * @service: a #GSocketService
31393 * Starts the service, i.e. start accepting connections
31394 * from the added sockets when the mainloop runs.
31395 * This call is threadsafe, so it may be called from a thread
31396 * handling an incomming client request.
31403 * G_IS_PARAM_SPEC_INT64:
31404 * @pspec: a valid #GParamSpec instance
31406 * Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64.
31408 * Returns: %TRUE on success.
31413 * G_FILE_ATTRIBUTE_FILESYSTEM_FREE:
31415 * A key in the "filesystem" namespace for getting the number of bytes of free space left on the
31416 * file system. Corresponding #GFileAttributeType is
31417 * %G_FILE_ATTRIBUTE_TYPE_UINT64.
31422 * g_socket_client_get_enable_proxy:
31423 * @client: a #GSocketClient.
31425 * Gets the proxy enable state; see g_socket_client_set_enable_proxy()
31427 * Returns: whether proxying is enabled
31433 * g_io_stream_close:
31434 * @stream: a #GIOStream
31435 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
31436 * @error: location to store the error occuring, or %NULL to ignore
31438 * Closes the stream, releasing resources related to it. This will also
31439 * closes the individual input and output streams, if they are not already
31441 * Once the stream is closed, all other operations will return
31442 * %G_IO_ERROR_CLOSED. Closing a stream multiple times will not
31444 * Closing a stream will automatically flush any outstanding buffers
31446 * Streams will be automatically closed when the last reference
31447 * is dropped, but you might want to call this function to make sure
31448 * resources are released as early as possible.
31449 * Some streams might keep the backing store of the stream (e.g. a file
31450 * descriptor) open after the stream is closed. See the documentation for
31451 * the individual stream for details.
31452 * On failure the first error that happened will be reported, but the
31453 * close operation will finish as much as possible. A stream that failed
31454 * to close will still return %G_IO_ERROR_CLOSED for all operations.
31455 * Still, it is important to check and report the error to the user,
31456 * otherwise there might be a loss of data as all data might not be written.
31457 * If @cancellable is not NULL, then the operation can be cancelled by
31458 * triggering the cancellable object from another thread. If the operation
31459 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
31460 * Cancelling a close will still leave the stream closed, but some streams
31461 * can use a faster close that doesn't block to e.g. check errors.
31462 * The default implementation of this method just calls close on the
31463 * individual input/output streams.
31465 * Returns: %TRUE on success, %FALSE on failure
31473 * An opaque structure used as the base of all type instances.
31478 * g_tcp_connection_set_graceful_disconnect:
31479 * @connection: a #GTcpConnection
31480 * @graceful_disconnect: Whether to do graceful disconnects or not
31482 * This enabled graceful disconnects on close. A graceful disconnect
31483 * means that we signal the recieving end that the connection is terminated
31484 * and wait for it to close the connection before closing the connection.
31485 * A graceful disconnect means that we can be sure that we successfully sent
31486 * all the outstanding data to the other end, or get an error reported.
31487 * However, it also means we have to wait for all the data to reach the
31488 * other side and for it to acknowledge this by closing the socket, which may
31489 * take a while. For this reason it is disabled by default.
31496 * G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE:
31498 * A key in the "standard" namespace for getting the fast content type.
31499 * The fast content type isn't as reliable as the regular one, as it
31500 * only uses the filename to guess it, but it is faster to calculate than the
31501 * regular content type.
31502 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
31507 * g_data_output_stream_put_string:
31508 * @stream: a #GDataOutputStream.
31510 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
31511 * @error: a #GError, %NULL to ignore.
31513 * Puts a string into the output stream.
31515 * Returns: %TRUE if @string was successfully added to the @stream.
31520 * GBaseFinalizeFunc:
31521 * @g_class: The #GTypeClass structure to finalize.
31523 * A callback function used by the type system to finalize those portions
31524 * of a derived types class structure that were setup from the corresponding
31525 * GBaseInitFunc() function. Class finalization basically works the inverse
31526 * way in which class intialization is performed.
31527 * See GClassInitFunc() for a discussion of the class intialization process.
31533 * @short_description: Error helper functions
31534 * @include: gio/gio.h
31536 * Contains helper functions for reporting errors to the user.
31541 * G_VARIANT_TYPE_HANDLE:
31543 * The type of a 32bit signed integer value, that by convention, is used
31544 * as an index into an array of file descriptors that are sent alongside
31546 * If you are not interacting with DBus, then there is no reason to make
31547 * use of this type.
31552 * g_unix_credentials_message_is_supported:
31554 * Checks if passing a #GCredential on a #GSocket is supported on this platform.
31556 * Returns: %TRUE if supported, %FALSE otherwise
31562 * GParamSpecDouble:
31563 * @parent_instance: private #GParamSpec portion
31564 * @minimum: minimum value for the property specified
31565 * @maximum: maximum value for the property specified
31566 * @default_value: default value for the property specified
31567 * @epsilon: values closer than @epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-90.
31569 * A #GParamSpec derived structure that contains the meta data for double properties.
31574 * GBusNameWatcherFlags:
31575 * @G_BUS_NAME_WATCHER_FLAGS_NONE: No flags set.
31576 * @G_BUS_NAME_WATCHER_FLAGS_AUTO_START: If no-one owns the name when beginning to watch the name, ask the bus to launch an owner for the name.
31578 * Flags used in g_bus_watch_name().
31585 * g_content_type_is_a:
31586 * @type: a content type string
31587 * @supertype: a content type string
31589 * Determines if @type is a subset of @supertype.
31590 * %FALSE otherwise.
31592 * Returns: %TRUE if @type is a kind of @supertype,
31597 /************************************************************/
31598 /* THIS FILE IS GENERATED DO NOT EDIT */
31599 /************************************************************/