gtk-sharp2.8.0.0Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details.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.
using System;
using Gtk;
class NotebookSample
{
static void Main ()
{
new NotebookSample ();
}
NotebookSample ()
{
Application.Init ();
Window win = new Window ("NotebookSample");
win.DeleteEvent += new DeleteEventHandler (OnWinDelete);
win.SetDefaultSize (400, 400);
Notebook nb = new Notebook ();
for (int i = 0; i < 5; i ++)
{
string label = String.Format ("Page {0}", i+1);
nb.AppendPage (new Button (label), new Label (label));
}
win.Add (nb);
win.ShowAll ();
Application.Run ();
}
void OnWinDelete (object obj, DeleteEventArgs args)
{
Application.Quit ();
}
}
(FIXME: all methods in this class should specify types in their param
elements, and this doc needs a good proofreading.)
Gtk.ContainerSystem.Reflection.DefaultMember(MemberName="Item")MethodSystem.StringReturns the label caption for the Notebookpage containing the given widget.
The widget in the page.
The text of the tab label, or if
the widget does not have a tab label other than the
default tab label, or the tab label page is not a .
Returns the tab label text 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 .
MethodSystem.StringReturns the label caption for the menu of the notebookpage containing the given widget.
The child widget in the page
The text of the menu label, or if
the widget does not have a menu label other than the
default menu label, or the menu label page is not a .
Retrieves the text of the menu label for the page
containing .
MethodSystem.VoidEnables 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.
MethodSystem.VoidSets 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 .
MethodSystem.VoidSwitches to the previous page.
Switches to the previous page. Nothing happens if the
current page is the first page.
MethodSystem.VoidEnables the page-selection popup.
Disables the popup menu. Inverse operation of MethodSystem.VoidRemoves 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.
MethodGtk.WidgetReturns the label for the menu of the notebookpage containing the given widget.
The child widget in the page.
The , or null if the page does not have a menu label other than the default menu label.the label of a menu doesn't have to be a . it can be any MethodSystem.VoidChanges 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.
MethodGtk.WidgetReturns the for the Notebook page containing the given widget.
The child widget in the page.
The label, or null if the page does not have a tab label other than the default tab label.
the label of a menu doesn't have to be a . it can be any MethodGtk.WidgetReturns the notebookpage with the given index.
the zero-based index of the page to return. use -1 for the last page.
returns the with the given index.MethodSystem.Voidsets the text of a menu label of a page.
the page.
the text of the label.
MethodSystem.Void
Switches to the next page.
Switches to the next page. Nothing happens if the
current page is the last page.
MethodSystem.VoidSets the menu label of a page.
the page
the to use as menu label. use null to get the same label as the tab label, this only works if the tab label is a MethodSystem.VoidSets the packing of the tab label of a page.
a page.
sets true to expand the label.
sets true to fill to fill the allocated area.
sets of the label.
ConstructorInternal constructor
Pointer to the C object.
This is an internal constructor, and should not be used by user code.ConstructorCreates a new object.This is the default constructor for .PropertySystem.Int32Sets or obtains the index of the curent page.
Returns the index of the current page .The index (starting from 0) of the current page in the notebook. If the notebook has no pages, then -1 will be returned. PropertySystem.BooleanIndicates if scroll arrows are added if there are too many tabs.Returns true if arrows are added and false if not.Default is false.GLib.Property(Name="scrollable")PropertySystem.BooleanIndicates if the tabs are shown.Returns true if the tabs are shown and false if not.Default value is true.GLib.Property(Name="show-tabs")PropertySystem.BooleanIndicates if the border is shown.Returns true if the border is shown and false if not.Default value is true.GLib.Property(Name="show-border")PropertySystem.UInt32Sets or obtains yhe width of the horizontal border arround the tabs.Returns the horizontal width of the border.Default value is 2.GLib.Property(Name="tab-hborder")System.Obsolete(Message=null, IsError=False)PropertySystem.BooleanIndicates if all the tabs have the same size.Returns a boolean to indicate if the tabs have the same size or not.True if the tabs have the same size and false if not. Default is false.GLib.Property(Name="homogeneous")System.Obsolete(Message=null, IsError=False)PropertySystem.UInt32Sets or obtains the width of the vertical border arround the tabs.Returns the vertical width of the border.Default value is 2.GLib.Property(Name="tab-vborder")System.Obsolete(Message=null, IsError=False)PropertySystem.UInt32Sets the width of the border arround the tabs..Default value is 2. This is a easy the change and at the same time. Use those properties to read the width.GLib.Property(Name="tab-border")System.Obsolete(Message=null, IsError=False)PropertySystem.Int32Sets or obtains the index of the curent page.Returns the index of the curent page.use instead.GLib.Property(Name="page")PropertyGtk.PositionTypeSets or obtains The position of the tabs.the of this notebook.default is top.GLib.Property(Name="tab-pos")PropertySystem.BooleanIndicates if the popup menu in enabled.Returns true if the popup menu is enabled and false if not.if true and the user clicks with the right mouse button on the tabs, a menu with all the pages will be popped up. GLib.Property(Name="enable-popup")EventGtk.SelectPageHandlerRaised when a page of the notebook is selected.GLib.Signal(CName="select_page")EventGtk.SwitchPageHandlerSignaled when the page changes
This signal is raised when the page is changed either by
the user or programatically.
GLib.Signal(CName="switch_page")EventGtk.MoveFocusOutHandlerSignaled when Focus is being moved out.
This event is raised before the focus is removed from the
current widget
GLib.Signal(CName="move_focus_out")EventGtk.ChangeCurrentPageHandlerSignaled 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.
GLib.Signal(CName="change_current_page")EventGtk.FocusTabHandlerSignaled when a Tab is focused
This event is raised when a tab has been focused.
GLib.Signal(CName="focus_tab")MethodSystem.VoidSets the label for the page containing a widget
the page
the to use as label. use null for the default label.
PropertySystem.Int32returns the amount of pages in this notebook.the amount of pages in the notebook.PropertyGtk.WidgetObtains the widget that represents the current page.The object in the current page.
This property uses and together to
provide a quicker way of getting the current page widget.
MethodSystem.VoidQuery the packing attributes for the tab label of the page containing child.
the page.
indicates if expand is true or false.
indicates if fill is true or false.
returns to which is used.
PropertyGLib.GTypeGType Property.a Returns the native value for .MethodSystem.BooleanDefault handler for the event.
a a Override this method in a subclass to provide a default handler for the event.MethodSystem.VoidDefault handler for the event.
a Override this method in a subclass to provide a default handler for the event.MethodSystem.VoidDefault handler for the event.
a Override this method in a subclass to provide a default handler for the event.MethodSystem.VoidDefault handler for the event.
a
a Override this method in a subclass to provide a default handler for the event.MethodSystem.BooleanDefault handler for the event.
a a Override this method in a subclass to provide a default handler for the event.ConstructorProtected Constructor.
a Chain to this constructor if you have manually registered a native value for your subclass.System.Obsolete(Message=null, IsError=False)MethodSystem.Int32Returns the page number that a child exists on. to look for.
Page number that the widget exists on, -1 if the widget isn't in the notebook.This function returns -1 if the is not a direct child of the notebook.PropertySystem.BooleanWhether tabs should have homogeneous sizes.a System.Obsolete(Message=null, IsError=False)MethodSystem.Int32prepends a page, with a custom popup-label.
the to use as contents of the page.
the to use as tab label. use null to use the default label.
the to use as menu label. use null to get the same label as the tab label, this only works if the tab label is a a Don't forget to call the Show method on the widget or else the new page will not be shown. MethodSystem.Int32prepends a page.
a t use as content of the page.
the to use as the tab label. use null to use the default label.
a Don't forget to call the Show method on the widget or else the new page will not be shown. MethodSystem.Int32Insert a page into notebook at the given position, with a custom popup-label.
The to use as th content of the page.
the to use as a label. use null for the default label.
the to use as menu label. use null to get the same label as the tab label, this only works if the tab label is a
the zero-based position to insert the page. use -1 make it the last page.
a
Don't forget to call the Show method on the widget or else the new page will not be shown.
MethodSystem.Int32Inserts 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.
a
Insert a page into the notebook at the given position.
Don't forget to call the Show method on the widget or else the new page will not be shown.
MethodSystem.Int32Appends 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.
a Appends a page to notebook, specifying the widget to use as the label in the popup menu. Don't forget to call the Show method on the widget or else the new page will not be shown. MethodSystem.Int32Appends 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'.
a
Appends a page to notebook. The tab widget is the and the content is .
Don't forget to call the Show method on the widget or else the new page will not be shown.