gtkstyleprovider.c 4.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* GTK - The GIMP Toolkit
 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
 *
 * 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 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
Javier Jardon's avatar
Javier Jardon committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20
 */

#include "config.h"

#include "gtkstyleprovider.h"
21

22
#include "gtkintl.h"
23 24
#include "gtkprivate.h"
#include "gtkwidgetpath.h"
25

Carlos Garnacho's avatar
Carlos Garnacho committed
26 27
/**
 * SECTION:gtkstyleprovider
28
 * @Short_description: Interface to provide style information to GtkStyleContext
Carlos Garnacho's avatar
Carlos Garnacho committed
29 30 31
 * @Title: GtkStyleProvider
 * @See_also: #GtkStyleContext, #GtkCssProvider
 *
32 33
 * GtkStyleProvider is an interface used to provide style information to a #GtkStyleContext.
 * See gtk_style_context_add_provider() and gtk_style_context_add_provider_for_screen().
Carlos Garnacho's avatar
Carlos Garnacho committed
34 35
 */

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
static void gtk_style_provider_iface_init (gpointer g_iface);

GType
gtk_style_provider_get_type (void)
{
  static GType style_provider_type = 0;

  if (!style_provider_type)
    style_provider_type = g_type_register_static_simple (G_TYPE_INTERFACE,
                                                         I_("GtkStyleProvider"),
                                                         sizeof (GtkStyleProviderIface),
                                                         (GClassInitFunc) gtk_style_provider_iface_init,
                                                         0, NULL, 0);
  return style_provider_type;
}

static void
gtk_style_provider_iface_init (gpointer g_iface)
{
}

Carlos Garnacho's avatar
Carlos Garnacho committed
57 58 59 60 61 62
/**
 * gtk_style_provider_get_style:
 * @provider: a #GtkStyleProvider
 * @path: #GtkWidgetPath to query
 *
 * Returns the style settings affecting a widget defined by @path, or %NULL if
63
 * @provider doesn’t contemplate styling @path.
Carlos Garnacho's avatar
Carlos Garnacho committed
64
 *
65
 * Returns: (nullable) (transfer full): a #GtkStyleProperties containing the
66
 * style settings affecting @path
Carlos Garnacho's avatar
Carlos Garnacho committed
67 68
 *
 * Since: 3.0
69 70 71
 *
 * Deprecated: 3.8: Will always return %NULL for all GTK-provided style providers
 *     as the interface cannot correctly work the way CSS is specified.
Carlos Garnacho's avatar
Carlos Garnacho committed
72
 **/
73
GtkStyleProperties *
74 75
gtk_style_provider_get_style (GtkStyleProvider *provider,
                              GtkWidgetPath    *path)
76 77 78 79 80 81 82 83 84 85
{
  GtkStyleProviderIface *iface;

  g_return_val_if_fail (GTK_IS_STYLE_PROVIDER (provider), NULL);

  iface = GTK_STYLE_PROVIDER_GET_IFACE (provider);

  if (!iface->get_style)
    return NULL;

86
  return iface->get_style (provider, path);
87 88
}

Carlos Garnacho's avatar
Carlos Garnacho committed
89 90 91 92
/**
 * gtk_style_provider_get_style_property:
 * @provider: a #GtkStyleProvider
 * @path: #GtkWidgetPath to query
93
 * @state: state to query the style property for
94
 * @pspec: The #GParamSpec to query
Carlos Garnacho's avatar
Carlos Garnacho committed
95 96 97
 * @value: (out): return location for the property value
 *
 * Looks up a widget style property as defined by @provider for
98
 * the widget represented by @path.
Carlos Garnacho's avatar
Carlos Garnacho committed
99 100
 *
 * Returns: %TRUE if the property was found and has a value, %FALSE otherwise
101 102
 *
 * Since: 3.0
Carlos Garnacho's avatar
Carlos Garnacho committed
103
 **/
104 105
gboolean
gtk_style_provider_get_style_property (GtkStyleProvider *provider,
Carlos Garnacho's avatar
Carlos Garnacho committed
106
                                       GtkWidgetPath    *path,
107
                                       GtkStateFlags     state,
108
                                       GParamSpec       *pspec,
109 110 111 112 113
                                       GValue           *value)
{
  GtkStyleProviderIface *iface;

  g_return_val_if_fail (GTK_IS_STYLE_PROVIDER (provider), FALSE);
114
  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
Carlos Garnacho's avatar
Carlos Garnacho committed
115
  g_return_val_if_fail (path != NULL, FALSE);
116
  g_return_val_if_fail (g_type_is_a (gtk_widget_path_get_object_type (path), pspec->owner_type), FALSE);
117 118 119 120 121 122 123
  g_return_val_if_fail (value != NULL, FALSE);

  iface = GTK_STYLE_PROVIDER_GET_IFACE (provider);

  if (!iface->get_style_property)
    return FALSE;

124
  return iface->get_style_property (provider, path, state, pspec, value);
125 126
}

Carlos Garnacho's avatar
Carlos Garnacho committed
127 128 129 130 131 132 133 134
/**
 * gtk_style_provider_get_icon_factory:
 * @provider: a #GtkStyleProvider
 * @path: #GtkWidgetPath to query
 *
 * Returns the #GtkIconFactory defined to be in use for @path, or %NULL if none
 * is defined.
 *
135
 * Returns: (nullable) (transfer none): The icon factory to use for @path, or %NULL
Carlos Garnacho's avatar
Carlos Garnacho committed
136 137
 *
 * Since: 3.0
138 139
 *
 * Deprecated: 3.8: Will always return %NULL for all GTK-provided style providers.
Carlos Garnacho's avatar
Carlos Garnacho committed
140
 **/
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
GtkIconFactory *
gtk_style_provider_get_icon_factory (GtkStyleProvider *provider,
				     GtkWidgetPath    *path)
{
  GtkStyleProviderIface *iface;

  g_return_val_if_fail (GTK_IS_STYLE_PROVIDER (provider), NULL);
  g_return_val_if_fail (path != NULL, NULL);

  iface = GTK_STYLE_PROVIDER_GET_IFACE (provider);

  if (!iface->get_icon_factory)
    return NULL;

  return iface->get_icon_factory (provider, path);
}