From b73bc36b8714143c5abfca187122533a3f412e2e Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Tue, 18 Feb 2003 06:20:42 +0000 Subject: [PATCH] 50% of Notebook is done svn path=/trunk/gtk-sharp/; revision=11671 --- doc/en/Gtk/Notebook.xml | 243 +++++++++++++++++++++++++++++++--------- 1 file changed, 189 insertions(+), 54 deletions(-) diff --git a/doc/en/Gtk/Notebook.xml b/doc/en/Gtk/Notebook.xml index 2f002b2d1..a775ed64c 100644 --- a/doc/en/Gtk/Notebook.xml +++ b/doc/en/Gtk/Notebook.xml @@ -1,14 +1,37 @@ - + gtk-sharp 0.0.0.0 - To be added + Can only be invoked by the thread running Gtk + code. - To be added - To be added + Notebook widget container + + + The Notebook widget is a whose + children are pages that can be switched between using tabs + along the edge. Tabs are typically + widgets, but can be any other widget. + + + There are many configuration options for Notebooks. Among + other things, you can choose on which edge the tabs appear + (The property), whether, if there + are too many tabs to fit the notebook should be made bigger + or scrolling arrows added (The property), + and whether there will be a popup menu allowing the users to + switch pages (The property). + + + Notebooks without tabs, can be used as containers to quickly + switch between different groups of information to reduce + any flicker caused by widget relayout by the application. + + Gtk.Container @@ -52,10 +75,18 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added + Returns the label widget for a given widget. + The widget in the page. + The tab label widget, or if + not found. + + + Returns the tab label widget for the page child. is returned if the child widget is not + in the notebook or if no tab label has specifically been + set for the . + + @@ -68,10 +99,22 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added + Returns the label caption for a given widget. + The child widget in the page + + + The text of the tab label, or if + the widget does not have a menu label other than the + default menu label, or the menu label widget is not a . + + + + + Retrieves the text of the menu label for the page + containing . + + @@ -82,8 +125,14 @@ - To be added - To be added + Enables the page-selection popup. + + + Enables the popup menu: if the user clicks with the right + mouse button on the bookmarks, a menu with all the pages + will be popped up. + + @@ -97,10 +146,15 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added + Sets the label for the page containing a widget + The child widget whose label will be changed + The new caption for the tab. + + + Creates a new label and sets it as the tab label for the + page containing . + + @@ -111,8 +165,13 @@ - To be added - To be added + Switches to the previous page. + + + Switches to the previous page. Nothing happens if the + current page is the first page. + + @@ -123,8 +182,12 @@ - To be added - To be added + Enables the page-selection popup. + + + Disables the popup menu. Inverse operation of + + @@ -137,9 +200,15 @@ - To be added - To be added: an object of type 'int' - To be added + Removes a page. + The page number to remove starting from + zero. You can use minus one to remove the last page. + + + Removes a page from the notebook given its index in the + notebook. + + @@ -153,10 +222,17 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + Appends a page. + The to use as the contents of the page. + + The to be + used as the label for the page, or to + use the default label, 'page N'. + + Appends a page to notebook. The tab widget is the and the content is + @@ -171,11 +247,23 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + Appends a page, with a custom popup-label. + The to use as + the contents of the page. The + to be used as the label for the + page, or to use the default label, + 'page N'. The widget to use + as a label for the page-switch menu, if its enabled. If is passed, and + is a or , then + the menu label will be a newly created label with the same + text as ; If is not a , + must be specified if the + page-switch menu is to be used. + + Appends a page to notebook, specifying the + widget to use as the label in the popup menu. @@ -190,16 +278,34 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'int' - To be added + Inserts a page into the notebook + + The to use as + the contents of the page. + + + The to be used as the label for + the page, or to use the default + label, 'page N'. + + + + The index (starting at 0) at which to insert the page, or -1 + to append the page after all other pages. + + + + + Insert a page into the notebook at the given position + + + - - Method + Method System.Void @@ -245,14 +351,23 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'int' - To be added + Changes the position of a widget in the notebook. + The widget to move. + The new position, or -1 to move to the end + + + Reorders the page containing , so + that it appears in position position. If position is greater + than or equal to the number of children in the list or + negative, will be moved to the end + of the list. + + - + Method System.Void @@ -679,8 +794,13 @@ - To be added - To be added + Signaled when the page changes + + + This signal is raised when the page is changed either by + the user or programatically. + + @@ -689,8 +809,13 @@ - To be added - To be added + Signaled when Focus is being moved out. + + + This event is raised before the focus is removed from the + current widget + + @@ -699,8 +824,14 @@ - To be added - To be added + Signaled when a request is made to change the current + page + + + This event is raised when a request is made to change the + current page in the notebook. + + @@ -709,8 +840,12 @@ - To be added - To be added + Signaled when a Tab is focused + + + This event is raised when a tab has been focused. + +