Disable documentation of gtk_plug_get_type and gtk_socket_get_type for

[~andy/gtk] / docs / styles.txt

diff --git a/docs/styles.txt b/docs/styles.txt
index a345bbce2eb79db78ed348e86b062c2d02f3c9ec..cd5dc911077f757cc5e442b6eb3176c6b5d9b89b 100644 (file)
--- a/docs/styles.txt
+++ b/docs/styles.txt
@@ -19,14 +19,12 @@ gtk_widget_set_style ()
   This will override a previously set user style or
   previously set rc styles.
 
-gtk_widget_set_rc_style ()
-  Set GTK_RC_STYLE to indicate that an rc lookup has been performed.
-  If there is an rc style for a widget, set it and save the default style,
-  restore the default style otherwise.
-  This will override a previously set user style or rc style.
+gtk_widget_reset_rc_styles ()
+  Descends through a widget hierarchy and sets the rc style
+  on all widgets that don't have a user style set.
 
 gtk_widget_ensure_style ()
-  Ensure taht the widget either has a user style set, or an rc lookup
+  Ensure that the widget either has a user style set, or an rc lookup
   has been performed.
 
 gtk_rc_get_style ()
@@ -38,57 +36,61 @@ gtk_widget_set_name ()
 
 gtk_widget_realize ()
   Besides realizing the widget this function will:
-  - perform an rc lookup if neccessary,
+  - perform an rc lookup if necessary,
   - attach a widget's style.
 
 gtk_widget_get_style ()
   Return a widgets style, this function will perform an rc lookup
-  if neccessary.
+  if necessary.
 
 gtk_widget_set_parent ()
   This function will perform rc lookups recursively for all widgets
   that do not have a user style set.
 
 gtk_style_copy ()
-  This function can be used to copy a widgets style.
-  The style can subsequntly be changed (e.g., by modifications to the
+  This function can be used to copy a widget's style.
+  The style can subsequently be changed (e.g., by modifications to the
   red/green/blue values of a certain color) and then be applied to the
   widget via gtk_widget_set_style().
 
 
 GtkWidget::style_set
-This signal will be emitted for a widget once its style changes with
-the previous style supplied.
-the GtkWidgetClass implements a default handler for this signal that
-will set the widget's window's background of widgets that provide their
-own windows according to the new style.
-Derived widgets need to overide this default handler, if:
-- their size requisition depends on the current style.
-  (e.g., on the style's fonts)
-- they set the background of widget->window to something other than.
-  style->bg. (e.g., GtkListItem)
-- the widget provides windows other than widget->window.
-- the widget has any other stored dependencies on the style.
+  This signal will be emitted for a widget once its style changes with
+  an additional argument previous_style which will hold the widget->style
+  value from a previous emission.
+  The initial emission of this signal is guaranteed to happen prior
+  to any GtkWidget::size_request emission, and will have the previous_style
+  argument set to NULL.
+  The GtkWidgetClass implements a default handler for this signal that
+  will set the widget's window's background of widgets that provide their
+  own windows according to the new style.
+  Derived widgets need to override this default handler, if:
+  - their size requisition depends on the current style.
+    (e.g., on the style's fonts)
+  - they set the background of widget->window to something other than.
+    style->bg. (e.g., GtkListItem)
+  - the widget provides windows other than widget->window.
+  - the widget has any other stored dependencies on the style.
                    
 
 
 Flag indications:
 
 !GTK_RC_STYLE && !GTK_USER_STYLE:
-  The widget has it's default style set, and no rc lookup has been
-  performed.
+  The widget has its default style set, no rc lookup has been
+  performed, the widget has not been size requested yet and is
+  therefore not yet realized.
 
 GTK_USER_STYLE:
   GTK_RC_STYLE is not set.
-  The widget has a user style assigned, and it's default style has been
+  The widget has a user style assigned, and its default style has been
   saved.
 
 GTK_RC_STYLE:
   GTK_USER_STYLE is not set.
   If the widget has a saved default style, it has been assigned an
-  rc style.
-  If the widget does not have a saved default style, it still has its
-  default style but an rc lookup has already been performed.
+  rc style. If the widget does not have a saved default style, it still
+  has its default style but an rc lookup has already been performed.
 
 
        - Tim Janik <timj@gimp.org>