* 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, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
#include "gtktypebuiltins.h"
+#include "deprecated/gtkstyle.h"
+
+
+/**
+ * SECTION:gtkiconfactory
+ * @Short_description: Manipulating stock icons
+ * @Title: Themeable Stock Images
+ *
+ * Browse the available stock icons in the list of stock IDs found <link
+ * linkend="gtk-Stock-Items">here</link>. You can also use
+ * the <application>gtk-demo</application> application for this purpose.
+ *
+ * An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a
+ * set of variants of a particular icon (i.e. a #GtkIconSet contains variants for
+ * different sizes and widget states). Icons in an icon factory are named by a
+ * stock ID, which is a simple string identifying the icon. Each #GtkStyle has a
+ * list of #GtkIconFactory derived from the current theme; those icon factories
+ * are consulted first when searching for an icon. If the theme doesn't set a
+ * particular icon, GTK+ looks for the icon in a list of default icon factories,
+ * maintained by gtk_icon_factory_add_default() and
+ * gtk_icon_factory_remove_default(). Applications with icons should add a default
+ * icon factory with their icons, which will allow themes to override the icons
+ * for the application.
+ *
+ * To display an icon, always use gtk_style_lookup_icon_set() on the widget that
+ * will display the icon, or the convenience function
+ * gtk_widget_render_icon(). These functions take the theme into account when
+ * looking up the icon to use for a given stock ID.
+ *
+ * <refsect2 id="GtkIconFactory-BUILDER-UI">
+ * <title>GtkIconFactory as GtkBuildable</title>
+ * <para>
+ * GtkIconFactory supports a custom <sources> element, which can contain
+ * multiple <source> elements.
+ * The following attributes are allowed:
+ * <variablelist>
+ * <varlistentry>
+ * <term>stock-id</term>
+ * <listitem><para>
+ * The stock id of the source, a string.
+ * This attribute is mandatory
+ * </para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>filename</term>
+ * <listitem><para>
+ * The filename of the source, a string.
+ * This attribute is optional
+ * </para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>icon-name</term>
+ * <listitem><para>
+ * The icon name for the source, a string.
+ * This attribute is optional.
+ * </para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>size</term>
+ * <listitem><para>
+ * Size of the icon, a #GtkIconSize enum value.
+ * This attribute is optional.
+ * </para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>direction</term>
+ * <listitem><para>
+ * Direction of the source, a #GtkTextDirection enum value.
+ * This attribute is optional.
+ * </para></listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>state</term>
+ * <listitem><para>
+ * State of the source, a #GtkStateType enum value.
+ * This attribute is optional.
+ * </para></listitem>
+ * </varlistentry>
+ * </variablelist>
+ * <example>
+ * <title>A #GtkIconFactory UI definition fragment.</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkIconFactory" id="iconfactory1">
+ * <sources>
+ * <source stock-id="apple-red" filename="apple-red.png"/>
+ * </sources>
+ * </object>
+ * <object class="GtkWindow" id="window1">
+ * <child>
+ * <object class="GtkButton" id="apple_button">
+ * <property name="label">apple-red</property>
+ * <property name="use-stock">True</property>
+ * </object>
+ * </child>
+ * </object>
+ * ]]>
+ * </programlisting>
+ * </example>
+ * </para>
+ * </refsect2>
+ */
+
static GSList *all_icon_factories = NULL;
* widget that will display the icon, instead of using this
* function directly, so that themes are taken into account.
*
- * Return value: icon set of @stock_id.
+ * Return value: (transfer none): icon set of @stock_id.
*/
GtkIconSet *
gtk_icon_factory_lookup (GtkIconFactory *factory,
return g_hash_table_lookup (priv->icons, stock_id);
}
-static GtkIconFactory *gtk_default_icons = NULL;
static GSList *default_factories = NULL;
/**
g_object_unref (factory);
}
-void
-_gtk_icon_factory_ensure_default_icons (void)
+static GtkIconFactory *
+_gtk_icon_factory_get_default_icons (void)
{
- if (gtk_default_icons == NULL)
- {
- gtk_default_icons = gtk_icon_factory_new ();
+ static GtkIconFactory *default_icons = NULL;
+ GtkIconFactory *icons = NULL;
+ GdkScreen *screen = gdk_screen_get_default ();
+
+ if (screen)
+ icons = g_object_get_data (G_OBJECT (screen), "gtk-default-icons");
- get_default_icons (gtk_default_icons);
+ if (icons == NULL)
+ {
+ if (default_icons == NULL)
+ {
+ default_icons = gtk_icon_factory_new ();
+ get_default_icons (default_icons);
+ }
+ if (screen)
+ g_object_set_data_full (G_OBJECT (screen),
+ I_("gtk-default-icons"),
+ default_icons,
+ g_object_unref);
+ icons = default_icons;
}
+
+ return icons;
}
/**
* using this function directly, so that themes are taken into
* account.
*
- * Return value: a #GtkIconSet, or %NULL
+ * Return value: (transfer none): a #GtkIconSet, or %NULL
*/
GtkIconSet *
gtk_icon_factory_lookup_default (const gchar *stock_id)
{
GSList *tmp_list;
+ GtkIconFactory *default_icons;
g_return_val_if_fail (stock_id != NULL, NULL);
tmp_list = g_slist_next (tmp_list);
}
- _gtk_icon_factory_ensure_default_icons ();
-
- return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
+ default_icons = _gtk_icon_factory_get_default_icons ();
+ if (default_icons)
+ return gtk_icon_factory_lookup (default_icons, stock_id);
+ else
+ return NULL;
}
static void
register_bidi_stock_icon (factory, GTK_STOCK_UNDELETE, GTK_STOCK_UNDELETE);
register_bidi_stock_icon (factory, GTK_STOCK_UNDO, "edit-undo");
register_stock_icon (factory, GTK_STOCK_GO_UP, "go-up");
- register_stock_icon (factory, GTK_STOCK_FILE, "document-x-generic");
+ register_stock_icon (factory, GTK_STOCK_FILE, "text-x-generic");
register_stock_icon (factory, GTK_STOCK_DIRECTORY, "folder");
register_stock_icon (factory, GTK_STOCK_ABOUT, "help-about");
register_stock_icon (factory, GTK_STOCK_CONNECT, GTK_STOCK_CONNECT);
/**
* gtk_icon_size_get_name:
* @size: (type int): a #GtkIconSize.
- * @returns: the name of the given icon size.
*
* Gets the canonical name of the given icon size. The returned string
* is statically allocated and should not be freed.
+ *
+ * Returns: the name of the given icon size.
*/
-G_CONST_RETURN gchar*
+const gchar*
gtk_icon_size_get_name (GtkIconSize size)
{
if (size >= icon_sizes_used)
/* Remove this icon source so we don't keep trying to
* load it.
*/
- g_warning (_("Error loading icon: %s"), error->message);
+ g_warning ("Error loading icon: %s", error->message);
g_error_free (error);
icon_set->sources = g_slist_remove (icon_set->sources, source);
if (info)
{
tmp_pixbuf = gtk_icon_info_load_icon (info, &error);
- gtk_icon_info_free (info);
+ g_object_unref (info);
}
else
tmp_pixbuf = NULL;
_gtk_icon_theme_ensure_builtin_cache ();
index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24");
- pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
- GTK_STOCK_MISSING_IMAGE,
- index);
+ pixbuf = _gtk_icon_cache_get_icon (_builtin_cache, "image-missing", index);
+
+ g_return_val_if_fail(pixbuf != NULL, NULL);
+
gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
g_object_unref (pixbuf);
}
else
state = GTK_STATE_NORMAL;
+G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
direction = gtk_style_context_get_direction (context);
+G_GNUC_END_IGNORE_DEPRECATIONS;
if (icon_set->sources)
{
}
gtk_style_context_set_state (context, flags);
+G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
gtk_style_context_set_direction (context, direction);
+G_GNUC_END_IGNORE_DEPRECATIONS;
icon = gtk_icon_set_render_icon_pixbuf (icon_set, context, size);
}
/**
- * gtk_icon_source_set_icon_name
+ * gtk_icon_source_set_icon_name:
* @source: a #GtkIconSource
* @icon_name: (allow-none): name of icon to use
*
* Return value: (type filename): image filename. This string must not
* be modified or freed.
*/
-G_CONST_RETURN gchar*
+const gchar*
gtk_icon_source_get_filename (const GtkIconSource *source)
{
g_return_val_if_fail (source != NULL, NULL);
*
* Return value: icon name. This string must not be modified or freed.
*/
-G_CONST_RETURN gchar*
+const gchar*
gtk_icon_source_get_icon_name (const GtkIconSource *source)
{
g_return_val_if_fail (source != NULL, NULL);
ids = NULL;
- _gtk_icon_factory_ensure_default_icons ();
+ _gtk_icon_factory_get_default_icons ();
tmp_list = all_icon_factories;
while (tmp_list != NULL)
} IconSourceParserData;
static void
-icon_source_start_element (GMarkupParseContext *context,
- const gchar *element_name,
- const gchar **names,
- const gchar **values,
- gpointer user_data,
- GError **error)
+icon_source_start_element (GMarkupParseContext *context,
+ const gchar *element_name,
+ const gchar **names,
+ const gchar **values,
+ gpointer user_data,
+ GError **error)
{
gint i;
gchar *stock_id = NULL;
if (!parser_data->in_source)
{
if (strcmp (element_name, "sources") != 0)
- {
- error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
- error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
- goto error;
- }
+ {
+ error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
+ error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
+ goto error;
+ }
parser_data->in_source = TRUE;
return;
}
else
{
if (strcmp (element_name, "source") != 0)
- {
- error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
- error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
- goto error;
- }
+ {
+ error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
+ error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
+ goto error;
+ }
}
for (i = 0; names[i]; i++)
{
if (strcmp (names[i], "stock-id") == 0)
- stock_id = g_strdup (values[i]);
+ stock_id = g_strdup (values[i]);
else if (strcmp (names[i], "filename") == 0)
- filename = g_strdup (values[i]);
+ filename = g_strdup (values[i]);
else if (strcmp (names[i], "icon-name") == 0)
- icon_name = g_strdup (values[i]);
+ icon_name = g_strdup (values[i]);
else if (strcmp (names[i], "size") == 0)
- {
+ {
if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE,
values[i],
&size,
error))
- return;
- }
+ return;
+ }
else if (strcmp (names[i], "direction") == 0)
- {
+ {
if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION,
values[i],
&direction,
error))
- return;
- }
+ return;
+ }
else if (strcmp (names[i], "state") == 0)
- {
+ {
if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE,
values[i],
&state,
error))
- return;
- }
+ return;
+ }
else
- {
- error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
- names[i], "source");
- error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
- goto error;
- }
+ {
+ error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
+ names[i], "source");
+ error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
+ goto error;
+ }
}
if (!stock_id)
gchar *tmp;
gint line_number, char_number;
- g_markup_parse_context_get_position (context,
- &line_number,
- &char_number);
+ g_markup_parse_context_get_position (context, &line_number, &char_number);
tmp = g_strdup_printf ("%s:%d:%d %s", "input",
- line_number, char_number, error_msg);
-#if 0
- g_set_error_literal (error,
- GTK_BUILDER_ERROR,
- error_domain,
- tmp);
-#else
- g_warning ("%s", tmp);
-#endif
+ line_number, char_number, error_msg);
+ g_set_error_literal (error, GTK_BUILDER_ERROR, error_domain, tmp);
g_free (tmp);
g_free (stock_id);
g_free (filename);
projects / ~andy / gtk / blobdiff