GNOME.org
 

[gtk+] Integrate GtkExtendedLayout docs

commit 82647f274c769dbf3ad1d12cdb315d87461dbf8f
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Apr 30 23:21:58 2010 -0400

    Integrate GtkExtendedLayout docs

 docs/reference/gtk/gtk-docs.sgml    |    9 ++++++
 docs/reference/gtk/gtk-sections.txt |   50 ++++++++++++++++++++++++++++++++++-
 docs/reference/gtk/gtk.types        |    1 +
 gtk/gtkextendedlayout.c             |   30 +++++++++++++-------
 gtk/gtkwidget.c                     |   14 +++++-----
 gtk/gtkwindow.c                     |    3 +-
 6 files changed, 87 insertions(+), 20 deletions(-)
---
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 0c50347..9e52a67 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -294,6 +294,7 @@ that is, GUI components such as #GtkButton or #GtkTextView.
       <xi:include href="xml/gtktable.xml" />
       <xi:include href="xml/gtkexpander.xml" />
       <xi:include href="xml/gtkorientable.xml" />
+      <xi:include href="xml/gtkextendedlayout.xml" />
     </chapter>
 
     <chapter id="Ornaments">
@@ -500,6 +501,14 @@ that is, GUI components such as #GtkButton or #GtkTextView.
     <title>Index of new symbols in 2.20</title>
     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-2-22" role="2.22">
+    <title>Index of new symbols in 2.20</title>
+    <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-0" role="3.0">
+    <title>Index of new symbols in 3.0</title>
+    <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
+  </index>
 
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 
diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index 3ffd3a6..b523590 100644
--- a/docs/reference/gtk/gtk-sections.txt
+++ b/docs/reference/gtk/gtk-sections.txt
@@ -154,6 +154,7 @@ gtk_accel_label_accelerator_width
 <TITLE>GtkAccessible</TITLE>
 GtkAccessible
 gtk_accessible_connect_widget_destroyed
+gtk_accessible_get_widget
 
 <SUBSECTION Standard>
 GTK_ACCESSIBLE
@@ -1374,7 +1375,9 @@ GTK_ENTRY_BUFFER_CLASS
 GTK_IS_ENTRY_BUFFER_CLASS
 GTK_ENTRY_BUFFER_GET_CLASS
 GTK_ENTRY_BUFFER_MAX_SIZE
+
 <SUBSECTION Private>
+GtkEntryBufferPrivate
 gtk_entry_buffer_get_type
 </SECTION>
 
@@ -2658,8 +2661,8 @@ GTK_IS_INFO_BAR_CLASS
 GTK_INFO_BAR_GET_CLASS
 
 <SUBSECTION Private>
+GtkInfoBarPrivate
 gtk_info_bar_get_type
-GtkMessageAreaPrivate
 </SECTION>
 
 <SECTION>
@@ -3618,6 +3621,7 @@ GtkSpinner
 gtk_spinner_new
 gtk_spinner_start
 gtk_spinner_stop
+
 <SUBSECTION Standard>
 GTK_SPINNER
 GTK_IS_SPINNER
@@ -3625,7 +3629,10 @@ GTK_TYPE_SPINNER
 GTK_SPINNER_CLASS
 GTK_IS_SPINER_CLASS
 GTK_SPINNER_GET_CLASS
+GTK_IS_SPINNER_CLASS
+
 <SUBSECTION Private>
+GtkSpinnerPrivate
 gtk_spinner_get_type
 </SECTION>
 
@@ -4063,6 +4070,8 @@ gtk_text_view_new
 gtk_text_view_new_with_buffer
 gtk_text_view_set_buffer
 gtk_text_view_get_buffer
+gtk_text_view_get_hadjustment
+gtk_text_view_get_vadjustment
 gtk_text_view_scroll_to_mark
 gtk_text_view_scroll_to_iter
 gtk_text_view_scroll_mark_onscreen
@@ -4512,6 +4521,7 @@ gtk_tool_item_group_set_item_position
 gtk_tool_item_group_set_label
 gtk_tool_item_group_set_label_widget
 gtk_tool_item_group_set_header_relief
+
 <SUBSECTION Standard>
 GtkToolItemGroupClass
 GTK_TOOL_ITEM_GROUP
@@ -4520,7 +4530,9 @@ GTK_TYPE_TOOL_ITEM_GROUP
 GTK_TOOL_ITEM_GROUP_CLASS
 GTK_IS_TOOL_ITEM_GROUP_CLASS
 GTK_TOOL_ITEM_GROUP_GET_CLASS
+
 <SUBSECTION Private>
+GtkToolItemGroupPrivate
 gtk_tool_item_group_get_type
 </SECTION>
 
@@ -6831,6 +6843,8 @@ GTK_IS_PRINT_OPERATION_PREVIEW
 GTK_PRINT_OPERATION_PREVIEW
 GTK_PRINT_OPERATION_PREVIEW_GET_IFACE
 GTK_TYPE_PRINT_OPERATION_PREVIEW
+GtkPrintOperationClass
+GtkPrintOperationPreviewIface
 
 <SUBSECTION Private>
 gtk_print_error_quark
@@ -7091,10 +7105,20 @@ gtk_paper_size_to_key_file
 
 <SUBSECTION Standard>
 GTK_TYPE_PAPER_SIZE
+GTK_CUSTOM_PAPER_UNIX_DIALOG
+GTK_CUSTOM_PAPER_UNIX_DIALOG_CLASS
+GTK_CUSTOM_PAPER_UNIX_DIALOG_GET_CLASS
+GTK_IS_CUSTOM_PAPER_UNIX_DIALOG
+GTK_IS_CUSTOM_PAPER_UNIX_DIALOG_CLASS
+GTK_TYPE_CUSTOM_PAPER_UNIX_DIALOG
+GtkCustomPaperUnixDialog
+GtkCustomPaperUnixDialogClass
+
 
 <SUBSECTION Private>
 gtk_paper_size_get_type
 gtk_custom_paper_unix_dialog_get_type
+GtkCustomPaperUnixDialogPrivate
 </SECTION>
 
 
@@ -7262,6 +7286,7 @@ GTK_MOUNT_OPERATION_CLASS
 GTK_MOUNT_OPERATION_GET_CLASS
 GTK_TYPE_MOUNT_OPERATION
 <SUBSECTION Private>
+GtkMountOperationLookupContext
 gtk_mount_operation_get_type
 GtkMountOperationPrivate
 </SECTION>
@@ -7285,3 +7310,26 @@ GTK_TYPE_ORIENTABLE
 <SUBSECTION Private>
 gtk_orientable_get_type
 </SECTION>
+
+<SECTION>
+<FILE>gtkextendedlayout</FILE>
+<TITLE>GtkExtendedLayout</TITLE>
+GtkExtendedLayout
+GtkExtendedLayoutIface
+gtk_extended_layout_get_desired_height
+gtk_extended_layout_get_desired_size
+gtk_extended_layout_get_desired_width
+gtk_extended_layout_get_height_for_width
+gtk_extended_layout_get_width_for_height
+gtk_extended_layout_is_height_for_width
+
+<SUBSECTION Standard>
+GTK_EXTENDED_LAYOUT
+GTK_EXTENDED_LAYOUT_CLASS
+GTK_EXTENDED_LAYOUT_GET_IFACE
+GTK_IS_EXTENDED_LAYOUT
+GTK_TYPE_EXTENDED_LAYOUT
+
+<SUBSECTION Private>
+gtk_extended_layout_get_type
+</SECTION>
diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types
index 1faa1f0..469ff7c 100644
--- a/docs/reference/gtk/gtk.types
+++ b/docs/reference/gtk/gtk.types
@@ -54,6 +54,7 @@ gtk_entry_completion_get_type
 gtk_entry_get_type
 gtk_event_box_get_type
 gtk_expander_get_type
+gtk_extended_layout_get_type
 gtk_file_chooser_button_get_type
 gtk_file_chooser_dialog_get_type
 gtk_file_chooser_get_type
diff --git a/gtk/gtkextendedlayout.c b/gtk/gtkextendedlayout.c
index b945bf2..baff6be 100644
--- a/gtk/gtkextendedlayout.c
+++ b/gtk/gtkextendedlayout.c
@@ -28,7 +28,16 @@
  * @Title: GtkExtendedLayout
  *
  * The extended layout is GTK+'s height-for-width (and width-for-height)
- * geometry management system.
+ * geometry management system. Height-for-width means that a widget can
+ * change how much vertical space it needs, depending on the amount
+ * of horizontal space that it is given (and similar for width-for-height).
+ * The most common example is a label that reflows to fill up the available
+ * width, wraps to fewer lines, and therefore needs less height.
+ *
+ * GTK+'s traditional two-pass <link linkend="size-allocation">size-allocation</link>
+ * algorithm does not allow this flexibility. #GtkWidget provides a default
+ * implementation of the #GtkExtendedLayout interface for existing widgets,
+ * which always requests the same height, regardless of the available width.
  *
  * <refsect2>
  * <title>Implementing GtkExtendedLayout</title>
@@ -397,13 +406,12 @@ gtk_extended_layout_get_desired_width (GtkExtendedLayout *layout,
 /**
  * gtk_extended_layout_get_desired_height:
  * @layout: a #GtkExtendedLayout instance
- * @minimum_width: (allow-none): location to store the minimum height, or %NULL
- * @natural_width: (allow-none): location to store the natural height, or %NULL
+ * @minimum_height: (allow-none): location to store the minimum height, or %NULL
+ * @natural_height: (allow-none): location to store the natural height, or %NULL
  *
  * Retrieves a widget's initial minimum and natural height.
  *
- * <note><para>This call is specific to width-for-height
- * requests.</para></note>
+ * <note><para>This call is specific to width-for-height requests.</para></note>
  *
  * Since: 3.0
  */
@@ -421,9 +429,9 @@ gtk_extended_layout_get_desired_height (GtkExtendedLayout *layout,
 /**
  * gtk_extended_layout_get_width_for_height:
  * @layout: a #GtkExtendedLayout instance
- * @height: the size which is available for allocation
- * @minimum_size: (allow-none): location for storing the minimum size, or %NULL
- * @natural_size: (allow-none): location for storing the natural size, or %NULL
+ * @height: the height which is available for allocation
+ * @minimum_width: (allow-none): location for storing the minimum width, or %NULL
+ * @natural_width: (allow-none): location for storing the natural width, or %NULL
  *
  * Retrieves a widget's desired width if it would be given
  * the specified @height.
@@ -443,9 +451,9 @@ gtk_extended_layout_get_width_for_height (GtkExtendedLayout *layout,
 /**
  * gtk_extended_layout_get_height_for_width:
  * @layout: a #GtkExtendedLayout instance
- * @width: the size which is available for allocation
- * @minimum_size: (allow-none): location for storing the minimum size, or %NULL
- * @natural_size: (allow-none): location for storing the natural size, or %NULL
+ * @width: the width which is available for allocation
+ * @minimum_height: (allow-none): location for storing the minimum height, or %NULL
+ * @natural_height: (allow-none): location for storing the natural height, or %NULL
  *
  * Retrieves a widget's desired height if it would be given
  * the specified @width.
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 982c85b..786d065 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -10202,13 +10202,13 @@ gtk_requisition_get_type (void)
  * @widget: a #GtkWidget
  *
  * Returns the accessible object that describes the widget to an
- * assistive technology. 
- * 
- * If no accessibility library is loaded (i.e. no ATK implementation library is 
- * loaded via <envar>GTK_MODULES</envar> or via another application library, 
- * such as libgnome), then this #AtkObject instance may be a no-op. Likewise, 
- * if no class-specific #AtkObject implementation is available for the widget 
- * instance in question, it will inherit an #AtkObject implementation from the 
+ * assistive technology.
+ *
+ * If no accessibility library is loaded (i.e. no ATK implementation library is
+ * loaded via <envar>GTK_MODULES</envar> or via another application library,
+ * such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
+ * if no class-specific #AtkObject implementation is available for the widget
+ * instance in question, it will inherit an #AtkObject implementation from the
  * first ancestor class for which such an implementation is defined.
  *
  * The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html";>ATK</ulink>
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index 424d8f9..1af7d02 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -8510,7 +8510,8 @@ gtk_window_get_window_type (GtkWindow *window)
   return window->type;
 }
 
-/* gtk_window_get_mnemonics_visible:
+/**
+ * gtk_window_get_mnemonics_visible:
  * @window: a #GtkWindow
  *
  * Gets the value of the #GtkWindow:mnemonics-visible property.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]