gtk/gtkstyleprovider.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "config.h"
  19
  20 #include "gtkstyleprovider.h"
  21
  22 #include "gtkintl.h"
  23 #include "gtkprivate.h"
  24 #include "gtkwidgetpath.h"
  25
  26 /**
  27  * SECTION:gtkstyleprovider
  28  * @Short_description: Interface to provide style information to GtkStyleContext
  29  * @Title: GtkStyleProvider
  30  * @See_also: #GtkStyleContext, #GtkCssProvider
  31  *
  32  * GtkStyleProvider is an interface used to provide style information to a #GtkStyleContext.
  33  * See gtk_style_context_add_provider() and gtk_style_context_add_provider_for_screen().
  34  */
  35
  36 static void gtk_style_provider_iface_init (gpointer g_iface);
  37
  38 GType
  39 gtk_style_provider_get_type (void)
  40 {
  41   static GType style_provider_type = 0;
  42
  43   if (!style_provider_type)
  44     style_provider_type = g_type_register_static_simple (G_TYPE_INTERFACE,
  45                                                          I_("GtkStyleProvider"),
  46                                                          sizeof (GtkStyleProviderIface),
  47                                                          (GClassInitFunc) gtk_style_provider_iface_init,
  48                                                          0, NULL, 0);
  49   return style_provider_type;
  50 }
  51
  52 static void
  53 gtk_style_provider_iface_init (gpointer g_iface)
  54 {
  55 }
  56
  57 /**
  58  * gtk_style_provider_get_style:
  59  * @provider: a #GtkStyleProvider
  60  * @path: #GtkWidgetPath to query
  61  *
  62  * Returns the style settings affecting a widget defined by @path, or %NULL if
  63  * @provider doesn't contemplate styling @path.
  64  *
  65  * Returns: (transfer full): a #GtkStyleProperties containing the
  66  * style settings affecting @path
  67  *
  68  * Since: 3.0
  69  **/
  70 GtkStyleProperties *
  71 gtk_style_provider_get_style (GtkStyleProvider *provider,
  72                               GtkWidgetPath    *path)
  73 {
  74   GtkStyleProviderIface *iface;
  75
  76   g_return_val_if_fail (GTK_IS_STYLE_PROVIDER (provider), NULL);
  77
  78   iface = GTK_STYLE_PROVIDER_GET_IFACE (provider);
  79
  80   if (!iface->get_style)
  81     return NULL;
  82
  83   return iface->get_style (provider, path);
  84 }
  85
  86 /**
  87  * gtk_style_provider_get_style_property:
  88  * @provider: a #GtkStyleProvider
  89  * @path: #GtkWidgetPath to query
  90  * @state: state to query the style property for
  91  * @pspec: The #GParamSpec to query
  92  * @value: (out): return location for the property value
  93  *
  94  * Looks up a widget style property as defined by @provider for
  95  * the widget represented by @path.
  96  *
  97  * Returns: %TRUE if the property was found and has a value, %FALSE otherwise
  98  *
  99  * Since: 3.0
 100  **/
 101 gboolean
 102 gtk_style_provider_get_style_property (GtkStyleProvider *provider,
 103                                        GtkWidgetPath    *path,
 104                                        GtkStateFlags     state,
 105                                        GParamSpec       *pspec,
 106                                        GValue           *value)
 107 {
 108   GtkStyleProviderIface *iface;
 109
 110   g_return_val_if_fail (GTK_IS_STYLE_PROVIDER (provider), FALSE);
 111   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
 112   g_return_val_if_fail (path != NULL, FALSE);
 113   g_return_val_if_fail (g_type_is_a (gtk_widget_path_get_object_type (path), pspec->owner_type), FALSE);
 114   g_return_val_if_fail (value != NULL, FALSE);
 115
 116   iface = GTK_STYLE_PROVIDER_GET_IFACE (provider);
 117
 118   if (!iface->get_style_property)
 119     return FALSE;
 120
 121   return iface->get_style_property (provider, path, state, pspec, value);
 122 }
 123
 124 /**
 125  * gtk_style_provider_get_icon_factory:
 126  * @provider: a #GtkStyleProvider
 127  * @path: #GtkWidgetPath to query
 128  *
 129  * Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none
 130  * is defined.
 131  *
 132  * Returns: (transfer none): The icon factory to use for @path, or %NULL
 133  *
 134  * Since: 3.0
 135  **/
 136 GtkIconFactory *
 137 gtk_style_provider_get_icon_factory (GtkStyleProvider *provider,
 138                                      GtkWidgetPath    *path)
 139 {
 140   GtkStyleProviderIface *iface;
 141
 142   g_return_val_if_fail (GTK_IS_STYLE_PROVIDER (provider), NULL);
 143   g_return_val_if_fail (path != NULL, NULL);
 144
 145   iface = GTK_STYLE_PROVIDER_GET_IFACE (provider);
 146
 147   if (!iface->get_icon_factory)
 148     return NULL;
 149
 150   return iface->get_icon_factory (provider, path);
 151 }