docs: try to clarify widget_get_state_flags vs context_get_state

This commit is contained in:
Paolo Borelli 2016-01-05 18:40:25 +01:00
parent 4a9c6777a7
commit c4996873dc
2 changed files with 10 additions and 1 deletions

View File

@ -959,7 +959,12 @@ gtk_style_context_set_state (GtkStyleContext *context,
* gtk_style_context_get_state:
* @context: a #GtkStyleContext
*
* Returns the state used when rendering.
* Returns the state used when rendering. This method should
* only be used to retrieve the #GtkStateFlags to pass to
* #GtkStyleContext methods, like gtk_style_context_get_padding().
*
* If you need to retrieve the current state of a #GtkWidget you
* should look at gtk_widget_get_state_flags().
*
* Returns: the state flags
*

View File

@ -8968,6 +8968,10 @@ gtk_widget_unset_state_flags (GtkWidget *widget,
* returned, that is, also based on parent insensitivity, even if
* @widget itself is sensitive.
*
* Also note that if you are looking for a way to obtain the
* #GtkStateFlags to pass to a #GtkStyleContext method, you
* should look at gtk_style_context_get_state().
*
* Returns: The state flags for widget
*
* Since: 3.0