2.9.0

[~andy/gtk] / docs / reference / gtk / tmpl / gtknotebook.sgml

diff --git a/docs/reference/gtk/tmpl/gtknotebook.sgml b/docs/reference/gtk/tmpl/gtknotebook.sgml
index 04ce877083e566de92bed98071871f05fc009d1e..8dc524e2f184a4ca87e4b87c5d0ce10b17de6f66 100644 (file)
--- a/docs/reference/gtk/tmpl/gtknotebook.sgml
+++ b/docs/reference/gtk/tmpl/gtknotebook.sgml
@@ -2,7 +2,7 @@
 GtkNotebook
 
 <!-- ##### SECTION Short_Description ##### -->
-A tabbed notebook container.
+A tabbed notebook container
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -30,12 +30,222 @@ will be a popup menu allowing the users to switch pages.
 </variablelist>
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT GtkNotebook ##### -->
 <para>
 
 </para>
 
 
+<!-- ##### SIGNAL GtkNotebook::change-current-page ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkNotebook::focus-tab ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@arg1: 
+@Returns: 
+
+<!-- ##### SIGNAL GtkNotebook::move-focus-out ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@arg1: 
+
+<!-- ##### SIGNAL GtkNotebook::page-added ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@widget: 
+@arg1: 
+
+<!-- ##### SIGNAL GtkNotebook::page-removed ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@widget: 
+@arg1: 
+
+<!-- ##### SIGNAL GtkNotebook::page-reordered ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@widget: 
+@arg1: 
+
+<!-- ##### SIGNAL GtkNotebook::reorder-tab ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@arg1: 
+@:
+@:
+@:
+@: 
+
+<!-- ##### SIGNAL GtkNotebook::select-page ##### -->
+<para>
+
+</para>
+
+@notebook: the object which received the signal.
+@arg1: 
+@Returns: 
+
+<!-- ##### SIGNAL GtkNotebook::switch-page ##### -->
+<para>
+Emitted when the user or a function changes the current page.
+</para>
+
+@notebook: the object which received the signal.
+@page: the new current page
+@page_num: the index of the page
+
+<!-- ##### ARG GtkNotebook:enable-popup ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:group-id ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:homogeneous ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:page ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:scrollable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:show-border ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:show-tabs ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-border ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-hborder ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-pos ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-vborder ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:detachable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:menu-label ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:position ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:reorderable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-expand ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-fill ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-label ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-pack ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:has-backward-stepper ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:has-forward-stepper ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:has-secondary-backward-stepper ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:has-secondary-forward-stepper ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-curvature ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkNotebook:tab-overlap ##### -->
+<para>
+
+</para>
+
 <!-- ##### STRUCT GtkNotebookPage ##### -->
 <para>
 The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
@@ -56,6 +266,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 @notebook: 
 @child: 
 @tab_label: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_notebook_append_page_menu ##### -->
@@ -66,6 +277,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 @child: 
 @tab_label: 
 @menu_label: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_notebook_prepend_page ##### -->
@@ -75,6 +287,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 @notebook: 
 @child: the
 @tab_label: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_notebook_prepend_page_menu ##### -->
@@ -85,6 +298,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 @child: 
 @tab_label: 
 @menu_label: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_notebook_insert_page ##### -->
@@ -95,6 +309,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 @child: 
 @tab_label: 
 @position: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_notebook_insert_page_menu ##### -->
@@ -106,6 +321,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 @tab_label: 
 @menu_label: 
 @position: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_notebook_remove_page ##### -->
@@ -118,7 +334,8 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 
 <!-- ##### MACRO gtk_notebook_current_page ##### -->
 <para>
-Deprecated compatibility macro.
+Deprecated compatibility macro. Use
+gtk_notebook_get_current_page() instead.
 </para>
 
 
@@ -134,11 +351,10 @@ Deprecated compatibility macro.
 
 <!-- ##### MACRO gtk_notebook_set_page ##### -->
 <para>
+Deprecated compatibility macro. Use
+gtk_notebook_set_current_page() instead.
 </para>
 
-<!-- # Unused Parameters # -->
-@notebook: 
-@page_num: 
 
 
 <!-- ##### FUNCTION gtk_notebook_next_page ##### -->
@@ -159,8 +375,6 @@ Deprecated compatibility macro.
 <para>
 </para>
 
-@notebook
-
 @notebook: 
 @child: 
 @position: 
@@ -246,6 +460,15 @@ Deprecated compatibility macro.
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_notebook_get_n_pages ##### -->
+<para>
+
+</para>
+
+@notebook: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_notebook_get_tab_label ##### -->
 <para>
 </para>
@@ -337,6 +560,26 @@ Deprecated compatibility macro.
 @tab_vborder: 
 
 
+<!-- ##### FUNCTION gtk_notebook_set_tab_reorderable ##### -->
+<para>
+
+</para>
+
+@notebook: 
+@child: 
+@reorderable: 
+
+
+<!-- ##### FUNCTION gtk_notebook_set_tab_detachable ##### -->
+<para>
+
+</para>
+
+@notebook: 
+@child: 
+@detachable: 
+
+
 <!-- ##### FUNCTION gtk_notebook_get_menu_label_text ##### -->
 <para>
 
@@ -393,88 +636,78 @@ Deprecated compatibility macro.
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_notebook_set_current_page ##### -->
+<!-- ##### FUNCTION gtk_notebook_get_tab_reorderable ##### -->
 <para>
 
 </para>
 
 @notebook: 
-@page_num: 
+@child: 
+@Returns: 
 
 
-<!-- ##### SIGNAL GtkNotebook::focus-tab ##### -->
+<!-- ##### FUNCTION gtk_notebook_get_tab_detachable ##### -->
 <para>
 
 </para>
 
-@notebook: the object which received the signal.
-@arg1: 
+@notebook: 
+@child: 
+@Returns: 
 
-<!-- ##### SIGNAL GtkNotebook::select-page ##### -->
+
+<!-- ##### FUNCTION gtk_notebook_set_current_page ##### -->
 <para>
 
 </para>
 
-@notebook: the object which received the signal.
-@arg1: 
+@notebook: 
+@page_num: 
 
-<!-- ##### SIGNAL GtkNotebook::switch-page ##### -->
+
+<!-- ##### FUNCTION gtk_notebook_set_group_id ##### -->
 <para>
-Emitted when the user or a function changes the current page.
+
 </para>
 
-@notebook: the object which received the signal.
-@page: the new current page
-@page_num: the index of the page
+@notebook: 
+@group_id: 
 
-<!-- ##### ARG GtkNotebook:tab-pos ##### -->
-<para>
-The edge at which the tabs for switching pages are drawn.
-</para>
 
-<!-- ##### ARG GtkNotebook:show-tabs ##### -->
+<!-- ##### FUNCTION gtk_notebook_get_group_id ##### -->
 <para>
-Whether to show tabs for the notebook pages.
-</para>
 
-<!-- ##### ARG GtkNotebook:show-border ##### -->
-<para>
-Whether to draw a bevel around the noteobook.
 </para>
 
-<!-- ##### ARG GtkNotebook:scrollable ##### -->
-<para>
-Whether the tab label area will have arrows for scrolling if there
-are too many tabs to fit in the area.
-</para>
+@notebook: 
+@Returns: 
 
-<!-- ##### ARG GtkNotebook:tab-border ##### -->
-<para>
-Whether the tab labels have a border on all sides.
-</para>
 
-<!-- ##### ARG GtkNotebook:tab-hborder ##### -->
+<!-- ##### USER_FUNCTION GtkNotebookWindowCreationFunc ##### -->
 <para>
-Whether the tab labels have a horizontal border.
-</para>
+A function used by GtkNotebook when a detachable tab is dropped
+in the root window, it's used to create a window containing a notebook
+where the tab will be attached. This function will also be responsible
+of moving/resizing the window and adding the necessary properties to
+the notebook (i.e.: group-id).
 
-<!-- ##### ARG GtkNotebook:tab-vborder ##### -->
-<para>
-Whether the tab labels have a vertical border.
+If the function returns %NULL, the drag will be cancelled.
 </para>
 
-<!-- ##### ARG GtkNotebook:page ##### -->
-<para>
-The current page
-</para>
+@source: The source #GtkNotebook of the drag operation
+@page: the child #GtkWidget affected
+@x: the X coordinate where the drop happens
+@y: the Y coordinate where the drop happens
+@data: user data
+@Returns: The created #GtkNotebook where the tab will be attached, or NULL to cancel the drag
 
-<!-- ##### ARG GtkNotebook:enable-popup ##### -->
-<para>
-Whether the popup menu for switching pages is enabled.
-</para>
 
-<!-- ##### ARG GtkNotebook:homogeneous ##### -->
+<!-- ##### FUNCTION gtk_notebook_set_window_creation_hook ##### -->
 <para>
-whether the tabs must have all the same size.
+
 </para>
 
+@func: 
+@data: 
+
+