callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve doc of gtk_style_context_get()

Browse Source 
When using this function in GtkSourceView (for GTK 3), there was a
mistake for retrieving a GdkRGBA value.

So, better document the function to avoid further mistakes.
This commit is contained in:
Sébastien Wilmet 2022-07-13 17:12:42 +02:00
parent 5c02deb893
commit fea466c13c
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
gtk/gtkstylecontext.c
View File

@ -896,13 +896,36 @@ gtk_style_context_get_valist (GtkStyleContext *context,
* gtk_style_context_get:
* @context: a #GtkStyleContext
* @state: state to retrieve the property values for
* @...: property name /return value pairs, followed by %NULL
* @...: property name / return value pairs, followed by %NULL
*
* Retrieves several style property values from @context for a
* given state.
*
* See gtk_style_context_get_property() for details.
*
* For the property name / return value pairs, it works similarly as
* g_object_get(). Example:
*
* |[<!-- language="C" -->
* GdkRGBA *background_color = NULL;
* PangoFontDescription *font_desc = NULL;
* gint border_radius = 0;
*
* gtk_style_context_get (style_context,
* gtk_style_context_get_state (style_context),
* GTK_STYLE_PROPERTY_BACKGROUND_COLOR, &background_color,
* GTK_STYLE_PROPERTY_FONT, &font_desc,
* GTK_STYLE_PROPERTY_BORDER_RADIUS, &border_radius,
* NULL);
*
* // Do something with the property values.
*
* if (background_color != NULL)
* gdk_rgba_free (background_color);
* if (font_desc != NULL)
* pango_font_description_free (font_desc);
* ]|
*
* Since: 3.0
*/
void