| /* GIO - GLib Input, Output and Streaming Library | |
| * | |
| * Copyright (C) 2006-2007 Red Hat, Inc. | |
| * | |
| * SPDX-License-Identifier: LGPL-2.1-or-later | |
| * | |
| * This library is free software; you can redistribute it and/or | |
| * modify it under the terms of the GNU Lesser General Public | |
| * License as published by the Free Software Foundation; either | |
| * version 2.1 of the License, or (at your option) any later version. | |
| * | |
| * This library is distributed in the hope that it will be useful, | |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| * Lesser General Public License for more details. | |
| * | |
| * You should have received a copy of the GNU Lesser General | |
| * Public License along with this library; if not, see <http://www.gnu.org/licenses/>. | |
| * | |
| * Author: Alexander Larsson <alexl@redhat.com> | |
| */ | |
| #ifndef __G_ICON_H__ | |
| #define __G_ICON_H__ | |
| #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) | |
| #error "Only <gio/gio.h> can be included directly." | |
| #endif | |
| #include <gio/giotypes.h> | |
| G_BEGIN_DECLS | |
| #define G_TYPE_ICON (g_icon_get_type ()) | |
| #define G_ICON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ICON, GIcon)) | |
| #define G_IS_ICON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ICON)) | |
| #define G_ICON_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ICON, GIconIface)) | |
| typedef struct _GIconIface GIconIface; | |
| /** | |
| * GIconIface: | |
| * @g_iface: The parent interface. | |
| * @hash: A hash for a given #GIcon. | |
| * @equal: Checks if two #GIcons are equal. | |
| * @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). | |
| * @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). | |
| * @serialize: Serializes a #GIcon into a #GVariant. Since: 2.38 | |
| * | |
| * GIconIface is used to implement GIcon types for various | |
| * different systems. See #GThemedIcon and #GLoadableIcon for | |
| * examples of how to implement this interface. | |
| */ | |
| struct _GIconIface | |
| { | |
| GTypeInterface g_iface; | |
| /* Virtual Table */ | |
| guint (* hash) (GIcon *icon); | |
| gboolean (* equal) (GIcon *icon1, | |
| GIcon *icon2); | |
| /** | |
| * GIconIface::to_tokens: | |
| * @icon: The #GIcon | |
| * @tokens: (element-type utf8) (out caller-allocates): | |
| * The array to fill with tokens | |
| * @out_version: (out): version of serialized tokens | |
| * | |
| * Serializes the @icon into string tokens. | |
| * This is can be invoked when g_icon_new_for_string() is called. | |
| * | |
| * Returns: %TRUE if serialization took place, %FALSE otherwise | |
| * | |
| * Since: 2.20 | |
| */ | |
| gboolean (* to_tokens) (GIcon *icon, | |
| GPtrArray *tokens, | |
| gint *out_version); | |
| /** | |
| * GIconIface::from_tokens: | |
| * @tokens: (array length=num_tokens): An array of tokens | |
| * @num_tokens: The number of tokens in @tokens | |
| * @version: Version of the serialized tokens | |
| * @error: Return location for errors, or %NULL to ignore | |
| * | |
| * Constructs a #GIcon from a list of @tokens. | |
| * | |
| * Returns: (nullable) (transfer full): the #GIcon or %NULL on error | |
| * | |
| * Since: 2.20 | |
| */ | |
| GIcon * (* from_tokens) (gchar **tokens, | |
| gint num_tokens, | |
| gint version, | |
| GError **error); | |
| GVariant * (* serialize) (GIcon *icon); | |
| }; | |
| GIO_AVAILABLE_IN_ALL | |
| GType g_icon_get_type (void) G_GNUC_CONST; | |
| GIO_AVAILABLE_IN_ALL | |
| guint g_icon_hash (gconstpointer icon); | |
| GIO_AVAILABLE_IN_ALL | |
| gboolean g_icon_equal (GIcon *icon1, | |
| GIcon *icon2); | |
| GIO_AVAILABLE_IN_ALL | |
| gchar *g_icon_to_string (GIcon *icon); | |
| GIO_AVAILABLE_IN_ALL | |
| GIcon *g_icon_new_for_string (const gchar *str, | |
| GError **error); | |
| GIO_AVAILABLE_IN_2_38 | |
| GVariant * g_icon_serialize (GIcon *icon); | |
| GIO_AVAILABLE_IN_2_38 | |
| GIcon * g_icon_deserialize (GVariant *value); | |
| G_END_DECLS | |
| #endif /* __G_ICON_H__ */ |