50% of Notebook is done

svn path=/trunk/gtk-sharp/; revision=11671
This commit is contained in:
Miguel de Icaza 2003-02-18 06:20:42 +00:00
parent fc1641eafb
commit b73bc36b87

View file

@ -1,14 +1,37 @@
<Type Name="Notebook" FullName="Gtk.Notebook">
<TypeSignature Language="C#" Value="public class Notebook : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Notebook : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="miguel" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<ThreadSafetyStatement>Can only be invoked by the thread running Gtk
code.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Notebook widget container</summary>
<remarks>
<para>
The Notebook widget is a <see cref="T:Gtk.Container"/> whose
children are pages that can be switched between using tabs
along the edge. Tabs are typically <see cref="T:Gtk.Label"/>
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
(The <see cref="P:Gtk.Notebook.TabPos"/> property), whether, if there
are too many tabs to fit the notebook should be made bigger
or scrolling arrows added (The <see
cref="P:Gtk.Notebook.Scrollable"/> property),
and whether there will be a popup menu allowing the users to
switch pages (The <see cref="P:Gtk.Notebook.EnablePopup"/> property).
</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>
</Docs>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
@ -52,10 +75,18 @@
<Parameter Name="child" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Returns the label widget for a given widget.</summary>
<param name="child">The widget in the page.</param>
<returns>The tab label widget, or <see langword="null"/> if
not found.</returns>
<remarks>
<para>
Returns the tab label widget for the page child. <see
langword="null"/> is returned if the child widget is not
in the notebook or if no tab label has specifically been
set for the <paramref name="child"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetMenuLabelText">
@ -68,10 +99,22 @@
<Parameter Name="child" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Returns the label caption for a given widget.</summary>
<param name="child">The child widget in the page</param>
<returns>
<para>
The text of the tab label, or <see langword="null"/> if
the widget does not have a menu label other than the
default menu label, or the menu label widget is not a <see
cref="T:Gtk.Label"/>.
</para>
</returns>
<remarks>
<para>
Retrieves the text of the menu label for the page
containing <paramref name="child"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PopupEnable">
@ -82,8 +125,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Enables the page-selection popup.</summary>
<remarks>
<para>
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>
</remarks>
</Docs>
</Member>
<Member MemberName="SetTabLabelText">
@ -97,10 +146,15 @@
<Parameter Name="tab_text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<param name="tab_text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<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>
<para>
Creates a new label and sets it as the tab label for the
page containing <paramref name="child"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PrevPage">
@ -111,8 +165,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Switches to the previous page.</summary>
<remarks>
<para>
Switches to the previous page. Nothing happens if the
current page is the first page.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PopupDisable">
@ -123,8 +182,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Enables the page-selection popup.</summary>
<remarks>
<para>
Disables the popup menu. Inverse operation of <see cref="M:Gtk.Notebook.PopupEnable()"/>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="RemovePage">
@ -137,9 +200,15 @@
<Parameter Name="page_num" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="page_num">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<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>
<para>
Removes a page from the notebook given its index in the
notebook.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AppendPage">
@ -153,10 +222,17 @@
<Parameter Name="tab_label" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<param name="tab_label">To be added: an object of type 'Gtk.Widget'</param>
<remarks>To be added</remarks>
<summary>Appends a page.</summary>
<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>
<remarks>
Appends a page to notebook. The tab widget is the <paramref
name="tab_label"/> and the content is <paramref
name="child"/>
</remarks>
</Docs>
</Member>
<Member MemberName="AppendPageMenu">
@ -171,11 +247,23 @@
<Parameter Name="menu_label" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<param name="tab_label">To be added: an object of type 'Gtk.Widget'</param>
<param name="menu_label">To be added: an object of type 'Gtk.Widget'</param>
<remarks>To be added</remarks>
<summary>Appends a page, with a custom popup-label.</summary>
<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
the menu label will be a newly created label with the same
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
page-switch menu is to be used.
</param>
<remarks><para>Appends a page to notebook, specifying the
widget to use as the label in the popup menu.</para></remarks>
</Docs>
</Member>
<Member MemberName="InsertPage">
@ -190,16 +278,34 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<param name="tab_label">To be added: an object of type 'Gtk.Widget'</param>
<param name="position">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Inserts a page into the notebook</summary>
<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="position">
The index (starting at 0) at which to insert the page, or -1
to append the page after all other pages.
</param>
<remarks>
<para>
Insert a page into the notebook at the given position
</para>
</remarks>
</Docs>
</Member>
<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>
<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>
@ -245,14 +351,23 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param>
<param name="position">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<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>
<para>
Reorders the page containing <paramref name="child"/>, so
that it appears in position position. If position is greater
than or equal to the number of children in the list or
negative, <paramref name="child"/> will be moved to the end
of the list.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetTabLabel">
<MemberSignature Language="C#" Value="public void SetTabLabel (Gtk.Widget child, Gtk.Widget tab_label);" />
<MemberSignature Language="C#" Value="public void SetTabLabel
(Gtk.Widget child, Gtk.Widget tab_label);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
@ -679,8 +794,13 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Signaled when the page changes</summary>
<remarks>
<para>
This signal is raised when the page is changed either by
the user or programatically.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MoveFocusOut">
@ -689,8 +809,13 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Signaled when Focus is being moved out.</summary>
<remarks>
<para>
This event is raised before the focus is removed from the
current widget
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ChangeCurrentPage">
@ -699,8 +824,14 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Signaled when a request is made to change the current
page</summary>
<remarks>
<para>
This event is raised when a request is made to change the
current page in the notebook.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="FocusTab">
@ -709,8 +840,12 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Signaled when a Tab is focused</summary>
<remarks>
<para>
This event is raised when a tab has been focused.
</para>
</remarks>
</Docs>
</Member>
</Members>