2003-02-12 02:00:12 +00:00
<Type Name= "Notebook" FullName= "Gtk.Notebook" >
2003-02-18 06:20:42 +00:00
<TypeSignature Language= "C#" Value= "public class Notebook : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer= "miguel" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
<AssemblyVersion > 0.0.0.0</AssemblyVersion>
2003-10-28 00:48:23 +00:00
<AssemblyCulture > neutral</AssemblyCulture>
2003-02-12 02:00:12 +00:00
<Attributes />
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<ThreadSafetyStatement > Gtk# is thread aware, but not thread safe; See the <link location= "node:gtk-sharp/programming/threads" > Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Notebook widget container</summary>
<remarks >
<para >
2003-02-23 07:26:30 +00:00
The Notebook widget is a <see cref= "T:Gtk.Container" /> whose
2003-02-18 06:20:42 +00:00
children are pages that can be switched between using tabs
2003-02-23 07:26:30 +00:00
along the edge. Tabs are typically <see cref= "T:Gtk.Label" />
2003-02-18 06:20:42 +00:00
widgets, but can be any other widget.
</para>
<para >
There are many configuration options for Notebooks. Among
other things, you can choose on which edge the tabs appear
2003-02-23 07:26:30 +00:00
(The <see cref= "P:Gtk.Notebook.TabPos" /> property), whether, if there
2003-02-18 06:20:42 +00:00
are too many tabs to fit the notebook should be made bigger
2003-02-23 07:26:30 +00:00
or scrolling arrows added (The <see cref= "P:Gtk.Notebook.Scrollable" /> property),
2003-02-18 06:20:42 +00:00
and whether there will be a popup menu allowing the users to
2003-02-23 07:26:30 +00:00
switch pages (The <see cref= "P:Gtk.Notebook.EnablePopup" /> property).
2003-02-18 06:20:42 +00:00
</para>
<para >
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.
</para>
</remarks>
2003-08-06 19:17:19 +00:00
<example >
<code language= "C#" >
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 ();
}
}
</code>
</example>
2003-02-12 02:00:12 +00:00
</Docs>
<Base >
<BaseTypeName > Gtk.Container</BaseTypeName>
</Base>
<Interfaces >
<Interface >
<InterfaceName > Atk.Implementor</InterfaceName>
</Interface>
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members >
<Member MemberName= "GetTabLabelText" >
<MemberSignature Language= "C#" Value= "public string GetTabLabelText (Gtk.Widget child);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Returns the label widget for a given widget.</summary>
<param name= "child" > The widget in the page.</param>
2003-02-23 07:26:30 +00:00
<returns > The tab label widget, or <see langword= "null" /> if
2003-02-18 06:20:42 +00:00
not found.</returns>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
Returns the tab label widget for the page child. <see langword= "null" /> is returned if the child widget is not
2003-02-18 06:20:42 +00:00
in the notebook or if no tab label has specifically been
2003-02-23 07:26:30 +00:00
set for the <paramref name= "child" /> .
2003-02-18 06:20:42 +00:00
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "GetMenuLabelText" >
<MemberSignature Language= "C#" Value= "public string GetMenuLabelText (Gtk.Widget child);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Returns the label caption for a given widget.</summary>
<param name= "child" > The child widget in the page</param>
<returns >
2003-02-23 07:26:30 +00:00
<para >
The text of the tab label, or <see langword= "null" /> if
2003-02-18 06:20:42 +00:00
the widget does not have a menu label other than the
2003-02-23 07:26:30 +00:00
default menu label, or the menu label widget is not a <see cref= "T:Gtk.Label" /> .
2003-02-18 06:20:42 +00:00
</para>
2003-02-23 07:26:30 +00:00
</returns>
2003-02-18 06:20:42 +00:00
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
Retrieves the text of the menu label for the page
2003-02-23 07:26:30 +00:00
containing <paramref name= "child" /> .
2003-02-18 06:20:42 +00:00
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "PopupEnable" >
<MemberSignature Language= "C#" Value= "public void PopupEnable ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Enables the page-selection popup.</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
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.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "SetTabLabelText" >
<MemberSignature Language= "C#" Value= "public void SetTabLabelText (Gtk.Widget child, string tab_text);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_text" Type= "System.String" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Sets the label for the page containing a widget</summary>
<param name= "child" > The child widget whose label will be changed</param>
<param name= "tab_text" > The new caption for the tab.</param>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
Creates a new label and sets it as the tab label for the
2003-02-23 07:26:30 +00:00
page containing <paramref name= "child" /> .
2003-02-18 06:20:42 +00:00
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "PrevPage" >
<MemberSignature Language= "C#" Value= "public void PrevPage ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Switches to the previous page.</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
Switches to the previous page. Nothing happens if the
current page is the first page.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "PopupDisable" >
<MemberSignature Language= "C#" Value= "public void PopupDisable ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Enables the page-selection popup.</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
Disables the popup menu. Inverse operation of <see cref= "M:Gtk.Notebook.PopupEnable()" /> </para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "RemovePage" >
<MemberSignature Language= "C#" Value= "public void RemovePage (int page_num);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "page_num" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Removes a page.</summary>
<param name= "page_num" > The page number to remove starting from
zero. You can use minus one to remove the last page.</param>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
Removes a page from the notebook given its index in the
notebook.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "AppendPage" >
<MemberSignature Language= "C#" Value= "public void AppendPage (Gtk.Widget child, Gtk.Widget tab_label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Appends a page.</summary>
2003-02-23 07:26:30 +00:00
<param name= "child" > The <see cref= "T:Gtk.Widget" /> to use as the contents of the page. </param>
<param name= "tab_label" > The <see cref= "T:Gtk.Widget" /> to be
used as the label for the page, or <see langword= "null" /> to
2003-02-18 06:20:42 +00:00
use the default label, 'page N'.</param>
2003-02-23 07:26:30 +00:00
<remarks >
Appends a page to notebook. The tab widget is the <paramref name= "tab_label" /> and the content is <paramref name= "child" /> </remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "AppendPageMenu" >
<MemberSignature Language= "C#" Value= "public void AppendPageMenu (Gtk.Widget child, Gtk.Widget tab_label, Gtk.Widget menu_label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
<Parameter Name= "menu_label" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Appends a page, with a custom popup-label.</summary>
2003-02-23 07:26:30 +00:00
<param name= "child" > The <see cref= "T:Gtk.Widget" /> to use as
the contents of the page. </param>
<param name= "tab_label" > The
<see cref= "T:Gtk.Widget" /> to be used as the label for the
page, or <see langword= "null" /> to use the default label,
'page N'.</param>
<param name= "menu_label" > The widget to use
as a label for the page-switch menu, if its enabled. If <see langword= "null" /> is passed, and <paramref name= "tab_label" />
is a <see cref= "T:Gtk.Label" /> or <see langword= "null" /> , then
2003-02-18 06:20:42 +00:00
the menu label will be a newly created label with the same
2003-02-23 07:26:30 +00:00
text as <paramref name= "tab_label" /> ; If <paramref name= "tab_label" /> is not a <see cref= "T:Gtk.Label" /> ,
<pararef name= "menu_label" /> must be specified if the
2003-02-18 06:20:42 +00:00
page-switch menu is to be used.
</param>
2003-02-23 07:26:30 +00:00
<remarks >
<para > Appends a page to notebook, specifying the
widget to use as the label in the popup menu.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "InsertPage" >
<MemberSignature Language= "C#" Value= "public void InsertPage (Gtk.Widget child, Gtk.Widget tab_label, int position);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
<Parameter Name= "position" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Inserts a page into the notebook</summary>
2003-02-23 07:26:30 +00:00
<param name= "child" > The <see cref= "T:Gtk.Widget" /> to use as
2003-02-18 06:20:42 +00:00
the contents of the page.</param>
2003-02-23 07:26:30 +00:00
<param name= "tab_label" >
The <see cref= "T:Gtk.Widget" /> to be used as the label for
the page, or <see langword= "null" /> to use the default
2003-02-18 06:20:42 +00:00
label, 'page N'.
</param>
2003-02-23 07:26:30 +00:00
<param name= "position" >
2003-02-18 06:20:42 +00:00
The index (starting at 0) at which to insert the page, or -1
to append the page after all other pages.
</param>
2003-02-23 07:26:30 +00:00
<remarks >
<para >
2003-02-18 06:20:42 +00:00
Insert a page into the notebook at the given position
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "GetMenuLabel" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget GetMenuLabel (Gtk.Widget child);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<returns > an object of type <see cref= "T:Gtk.Widget" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "ReorderChild" >
<MemberSignature Language= "C#" Value= "public void ReorderChild (Gtk.Widget child, int position);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "position" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Changes the position of a widget in the notebook.</summary>
<param name= "child" > The widget to move.</param>
<param name= "position" > The new position, or -1 to move to the end</param>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
Reorders the page containing <paramref name= "child" /> , so
2003-02-18 06:20:42 +00:00
that it appears in position position. If position is greater
than or equal to the number of children in the list or
2003-02-23 07:26:30 +00:00
negative, <paramref name= "child" /> will be moved to the end
2003-02-18 06:20:42 +00:00
of the list.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "GetTabLabel" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget GetTabLabel (Gtk.Widget child);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<returns > an object of type <see cref= "T:Gtk.Widget" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "GetNthPage" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget GetNthPage (int page_num);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "page_num" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "page_num" > an object of type <see cref= "T:System.Int32" /> </param>
<returns > an object of type <see cref= "T:Gtk.Widget" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "SetMenuLabelText" >
<MemberSignature Language= "C#" Value= "public void SetMenuLabelText (Gtk.Widget child, string menu_text);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "menu_text" Type= "System.String" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "menu_text" > an object of type <see cref= "T:System.String" /> </param>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "PrependPage" >
<MemberSignature Language= "C#" Value= "public void PrependPage (Gtk.Widget child, Gtk.Widget tab_label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "tab_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "NextPage" >
<MemberSignature Language= "C#" Value= "public void NextPage ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "PrependPageMenu" >
<MemberSignature Language= "C#" Value= "public void PrependPageMenu (Gtk.Widget child, Gtk.Widget tab_label, Gtk.Widget menu_label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
<Parameter Name= "menu_label" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "tab_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "menu_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "SetMenuLabel" >
<MemberSignature Language= "C#" Value= "public void SetMenuLabel (Gtk.Widget child, Gtk.Widget menu_label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "menu_label" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "menu_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "SetTabLabelPacking" >
<MemberSignature Language= "C#" Value= "public void SetTabLabelPacking (Gtk.Widget child, bool expand, bool fill, Gtk.PackType pack_type);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "expand" Type= "System.Boolean" />
<Parameter Name= "fill" Type= "System.Boolean" />
<Parameter Name= "pack_type" Type= "Gtk.PackType" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "expand" > an object of type <see cref= "T:System.Boolean" /> </param>
<param name= "fill" > an object of type <see cref= "T:System.Boolean" /> </param>
<param name= "pack_type" > an object of type <see cref= "T:Gtk.PackType" /> </param>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Finalize" >
2003-10-13 22:55:58 +00:00
<MemberSignature Language= "C#" Value= "protected override void Finalize ();" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Disposes the resources associated with the object.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Notebook (IntPtr raw);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Internal constructor</summary>
<param name= "raw" > Pointer to the C object.</param>
<returns > An instance of Notebook, wrapping the C object.</returns>
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Notebook ();" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs >
2003-08-06 19:17:19 +00:00
<summary > Creates a new <see cref= "T:Gtk.Notebook" /> object.</summary>
<returns > an object of type <see cref= "T:Gtk.Notebook" /> </returns>
<remarks > This is the default constructor for <see cref= "T:Gtk.Notebook" /> .</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "CurrentPage" >
<MemberSignature Language= "C#" Value= "public int CurrentPage { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Int32" /> </param>
<returns > an object of type <see cref= "T:System.Int32" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Scrollable" >
<MemberSignature Language= "C#" Value= "public bool Scrollable { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Boolean" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "ShowTabs" >
<MemberSignature Language= "C#" Value= "public bool ShowTabs { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Boolean" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "ShowBorder" >
<MemberSignature Language= "C#" Value= "public bool ShowBorder { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Boolean" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "TabHborder" >
<MemberSignature Language= "C#" Value= "public uint TabHborder { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.UInt32" /> </param>
<returns > an object of type <see cref= "T:System.UInt32" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Homogeneous" >
<MemberSignature Language= "C#" Value= "public bool Homogeneous { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Boolean" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "TabVborder" >
<MemberSignature Language= "C#" Value= "public uint TabVborder { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.UInt32" /> </param>
<returns > an object of type <see cref= "T:System.UInt32" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "TabBorder" >
<MemberSignature Language= "C#" Value= "public uint TabBorder { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.UInt32" /> </param>
<returns > an object of type <see cref= "T:System.UInt32" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "Page" >
<MemberSignature Language= "C#" Value= "public int Page { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Int32" /> </param>
<returns > an object of type <see cref= "T:System.Int32" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "TabPos" >
<MemberSignature Language= "C#" Value= "public Gtk.PositionType TabPos { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.PositionType</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:Gtk.PositionType" /> </param>
<returns > an object of type <see cref= "T:Gtk.PositionType" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "EnablePopup" >
<MemberSignature Language= "C#" Value= "public bool EnablePopup { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "value" > an object of type <see cref= "T:System.Boolean" /> </param>
<returns > an object of type <see cref= "T:System.Boolean" /> </returns>
2003-02-12 02:00:12 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "SelectPage" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.SelectPageHandler SelectPage;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-08-06 06:11:18 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.SelectPageHandler</ReturnType>
2003-08-06 06:11:18 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
<summary > To be added</summary>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "SwitchPage" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.SwitchPageHandler SwitchPage;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-08-06 06:11:18 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.SwitchPageHandler</ReturnType>
2003-08-06 06:11:18 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Signaled when the page changes</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
This signal is raised when the page is changed either by
the user or programatically.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "MoveFocusOut" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.MoveFocusOutHandler MoveFocusOut;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-08-06 06:11:18 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.MoveFocusOutHandler</ReturnType>
2003-08-06 06:11:18 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Signaled when Focus is being moved out.</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
This event is raised before the focus is removed from the
current widget
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "ChangeCurrentPage" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.ChangeCurrentPageHandler ChangeCurrentPage;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-08-06 06:11:18 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.ChangeCurrentPageHandler</ReturnType>
2003-08-06 06:11:18 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Signaled when a request is made to change the current
page</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
This event is raised when a request is made to change the
current page in the notebook.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "FocusTab" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.FocusTabHandler FocusTab;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-08-06 06:11:18 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.FocusTabHandler</ReturnType>
2003-08-06 06:11:18 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-02-18 06:20:42 +00:00
<summary > Signaled when a Tab is focused</summary>
<remarks >
2003-02-23 07:26:30 +00:00
<para >
2003-02-18 06:20:42 +00:00
This event is raised when a tab has been focused.
</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2003-03-07 01:30:00 +00:00
<Member MemberName= "InsertPageMenu" >
<MemberSignature Language= "C#" Value= "public void InsertPageMenu (Gtk.Widget child, Gtk.Widget tab_label, Gtk.Widget menu_label, int position);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
<Parameter Name= "menu_label" Type= "Gtk.Widget" />
<Parameter Name= "position" Type= "System.Int32" />
</Parameters>
2003-03-07 01:30:00 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "tab_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "menu_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "position" > an object of type <see cref= "T:System.Int32" /> </param>
2003-03-07 01:30:00 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "SetTabLabel" >
<MemberSignature Language= "C#" Value= "public void SetTabLabel (Gtk.Widget child, Gtk.Widget tab_label);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-08-06 06:11:18 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "tab_label" Type= "Gtk.Widget" />
</Parameters>
2003-03-07 01:30:00 +00:00
<Docs >
<summary > To be added</summary>
2003-08-06 19:17:19 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> </param>
<param name= "tab_label" > an object of type <see cref= "T:Gtk.Widget" /> </param>
2003-03-07 01:30:00 +00:00
<remarks > To be added</remarks>
</Docs>
</Member>
2003-07-17 06:38:40 +00:00
<Member MemberName= "NPages" >
<MemberSignature Language= "C#" Value= "public int NPages { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Docs >
<summary > To be added</summary>
<returns > a <see cref= "T:System.Int32" /> </returns>
<remarks > To be added</remarks>
</Docs>
</Member>
2003-08-06 06:11:18 +00:00
<Member MemberName= "CurrentPageWidget" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget CurrentPageWidget { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Docs >
<summary > Obtains the widget that represents the current page.</summary>
2003-08-06 19:17:19 +00:00
<returns > The <see cref= "T:Gtk.Widget" /> object in the current page.</returns>
2003-08-06 06:11:18 +00:00
<remarks >
<para >
This property uses <see cref= "P:Gtk.Notebook.CurrentPage" /> and <see cref= "M:Gtk.Notebook.GetNthPage" /> together to
provide a quicker way of getting the current page widget.
</para>
</remarks>
</Docs>
</Member>
2003-10-28 00:48:23 +00:00
<Member MemberName= "QueryTabLabelPacking" >
<MemberSignature Language= "C#" Value= "public void QueryTabLabelPacking (Gtk.Widget child, out bool expand, out bool fill, out Gtk.PackType pack_type);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "expand" Type= "System.Boolean&" RefType= "out" />
<Parameter Name= "fill" Type= "System.Boolean&" RefType= "out" />
<Parameter Name= "pack_type" Type= "Gtk.PackType&" RefType= "out" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "child" > a <see cref= "T:Gtk.Widget" /> </param>
<param name= "expand" > a <see cref= "T:System.Boolean&" /> </param>
<param name= "fill" > a <see cref= "T:System.Boolean&" /> </param>
<param name= "pack_type" > a <see cref= "T:Gtk.PackType&" /> </param>
<remarks > To be added</remarks>
</Docs>
</Member>
2003-12-24 01:35:30 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<returns > a <see cref= "T:GLib.GType" /> </returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "OnFocusTab" >
<MemberSignature Language= "C#" Value= "protected virtual bool OnFocusTab (Gtk.NotebookTab type);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "type" Type= "Gtk.NotebookTab" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "type" > a <see cref= "T:Gtk.NotebookTab" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "OnChangeCurrentPage" >
<MemberSignature Language= "C#" Value= "protected virtual void OnChangeCurrentPage (int offset);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "offset" Type= "System.Int32" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "offset" > a <see cref= "T:System.Int32" /> </param>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "OnMoveFocusOut" >
<MemberSignature Language= "C#" Value= "protected virtual void OnMoveFocusOut (Gtk.DirectionType direction);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "direction" Type= "Gtk.DirectionType" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "direction" > a <see cref= "T:Gtk.DirectionType" /> </param>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "OnSwitchPage" >
<MemberSignature Language= "C#" Value= "protected virtual void OnSwitchPage (Gtk.NotebookPage page, uint page_num);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "page" Type= "Gtk.NotebookPage" />
<Parameter Name= "page_num" Type= "System.UInt32" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "page" > a <see cref= "T:Gtk.NotebookPage" /> </param>
<param name= "page_num" > a <see cref= "T:System.UInt32" /> </param>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= "OnSelectPage" >
<MemberSignature Language= "C#" Value= "protected virtual bool OnSelectPage (bool move_focus);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "move_focus" Type= "System.Boolean" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "move_focus" > a <see cref= "T:System.Boolean" /> </param>
<returns > a <see cref= "T:System.Boolean" /> </returns>
<remarks > To be added</remarks>
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected Notebook (GLib.GType gtype);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "gtype" Type= "GLib.GType" />
</Parameters>
<Docs >
<summary > To be added</summary>
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
<returns > a <see cref= "T:Gtk.Notebook" /> </returns>
<remarks > To be added</remarks>
</Docs>
</Member>
2004-01-12 22:48:13 +00:00
<Member MemberName= "PageNum" >
<MemberSignature Language= "C#" Value= "public int PageNum (Gtk.Widget child);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "child" Type= "Gtk.Widget" />
</Parameters>
<Docs >
2004-04-12 14:16:11 +00:00
<summary > Returns the page number that a child <see cref= "T:Gtk.Widget" /> exists on.</summary>
<param name= "child" >
<see cref= "T:Gtk.Widget" /> to look for.</param>
<returns > Page number that the widget exists on, -1 if the widget isn't in the notebook.</returns>
<remarks > This function returns -1 if the <see cref= "T:Gtk.Widget" /> is not a direct child of the notebook.</remarks>
2004-01-12 22:48:13 +00:00
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2004-02-26 18:46:28 +00:00
</Type>