svn path=/trunk/gtk-sharp/; revision=30599
This commit is contained in:
Miguel de Icaza 2004-07-01 02:12:04 +00:00
parent 621f34de12
commit 00acb32df1
4 changed files with 97 additions and 47 deletions

View file

@ -15,6 +15,44 @@
<para> <para>
The result is a standard menu bar which can hold many menu items. <see cref="T:Gtk.MenuBar" /> allows for a shadow type to be set for aesthetic purposes. The result is a standard menu bar which can hold many menu items. <see cref="T:Gtk.MenuBar" /> allows for a shadow type to be set for aesthetic purposes.
</para> </para>
<example>
<code lang="C#">
using System;
using Gtk;
public class MenuApp {
public static void Main (string[] args)
{
new MenuApp();
}
public MenuApp(){
Application.Init();
Window win = new Window ("Menu Sample App");
MenuBar mb = new MenuBar ();
Menu file_menu = new Menu ();
MenuItem exit_item = new MenuItem("Exit");
exit_item.Activated += new EventHandler (on_exit_item_activate);
file_menu.Append (exit_item);
MenuItem file_item = new MenuItem("File");
file_item.Submenu = file_menu;
mb.Append (file_item);
win.Add (mb);
win.ShowAll ();
Application.Run ();
}
public void on_exit_item_activate(object o, EventArgs args)
{
Application.Quit ();
}
</code>
</example>
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>

View file

@ -13,6 +13,17 @@
<summary>A widget used for items in menus.</summary> <summary>A widget used for items in menus.</summary>
<remarks> <remarks>
<para>The <see cref="T:Gtk.MenuItem" /> and derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.</para> <para>The <see cref="T:Gtk.MenuItem" /> and derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.</para>
<example>
<code lang="C#">
MenuBar mb = new MenuBar ();
Menu file_menu = new Menu ();
MenuItem exit_item = new MenuItem("Exit");
file_menu.Append (exit_item);
MenuItem file_item = new MenuItem("File");
file_item.Submenu = file_menu;
mb.Append (file_item);
</code>
</example>
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>

View file

@ -542,10 +542,11 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The index of the curent page.
<param name="value">an object of type <see cref="T:System.Int32" /></param> </summary>
<returns>an object of type <see cref="T:System.Int32" /></returns> <param name="value">the index of the page to switch to.</param>
<remarks>To be added</remarks> <returns>Returns the index of the current page .</returns>
<remarks>The index (starting from 0) of the current page in the notebook. If the notebook has no pages, then -1 will be returned. </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Scrollable"> <Member MemberName="Scrollable">
@ -557,10 +558,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicates if scroll arrows are added if there are too many tabs.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param> <param name="value">a Boolean value to select if scroll arrows are added or not.</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns> <returns>Returns true if arrows are added and false if not.</returns>
<remarks>To be added</remarks> <remarks>Default is false.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowTabs"> <Member MemberName="ShowTabs">
@ -572,10 +573,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicates if the tabs are shown.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param> <param name="value">a Boolean value to select if the tabs are shown or not.</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns> <returns>Returns true if the tabs are shown and false if not.</returns>
<remarks>To be added</remarks> <remarks>Default value is true.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ShowBorder"> <Member MemberName="ShowBorder">
@ -587,10 +588,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicates if the border is shown.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param> <param name="value">a Boolean value to select if the border should be shown or not.</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns> <returns>Returns true if the border is shown and false if not.</returns>
<remarks>To be added</remarks> <remarks>Default value is true.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TabHborder"> <Member MemberName="TabHborder">
@ -602,10 +603,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains yhe width of the horizontal border arround the tabs.</summary>
<param name="value">an object of type <see cref="T:System.UInt32" /></param> <param name="value">a uint value to select the horizontal width of the border. </param>
<returns>an object of type <see cref="T:System.UInt32" /></returns> <returns>Returns the horizontal width of the border.</returns>
<remarks>To be added</remarks> <remarks>Default value is 2.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Homogeneous"> <Member MemberName="Homogeneous">
@ -617,10 +618,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Indicates if all the tabs have the same size.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param> <param name="value">Selects if the tabs have the same size or not. </param>
<returns>an object of type <see cref="T:System.Boolean" /></returns> <returns>Returns a boolean to indicate if the tabs have the same size or not.</returns>
<remarks>To be added</remarks> <remarks>True if the tabs have the same size and false if not. Default is false.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TabVborder"> <Member MemberName="TabVborder">
@ -632,10 +633,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains the width of the vertical border arround the tabs.</summary>
<param name="value">an object of type <see cref="T:System.UInt32" /></param> <param name="value">a uint value to select the vertical width of the border. </param>
<returns>an object of type <see cref="T:System.UInt32" /></returns> <returns>Returns the vertical width of the border.</returns>
<remarks>To be added</remarks> <remarks>Default value is 2.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TabBorder"> <Member MemberName="TabBorder">
@ -647,10 +648,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the width of the border arround the tabs..</summary>
<param name="value">an object of type <see cref="T:System.UInt32" /></param> <param name="value">a uint value to select the width of the border. </param>
<returns>an object of type <see cref="T:System.UInt32" /></returns> <returns />
<remarks>To be added</remarks> <remarks>Default value is 2. This is a easy the change <see cref="P:Gtk.Notebook.TabHborder" /> and <see cref="P:Gtk.Notebook.TabVborder" /> at the same time. Use those properties to read the width.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Page"> <Member MemberName="Page">
@ -662,10 +663,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The index of the curent page.</summary>
<param name="value">an object of type <see cref="T:System.Int32" /></param> <param name="value">The index of the page to switch to.</param>
<returns>an object of type <see cref="T:System.Int32" /></returns> <returns>Returns the index of the curent page.</returns>
<remarks>To be added</remarks> <remarks>use <see cref="P:Gtk.Notebook.CurrentPage" /> instead.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TabPos"> <Member MemberName="TabPos">
@ -677,10 +678,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets or obtains The position of the tabs.</summary>
<param name="value">an object of type <see cref="T:Gtk.PositionType" /></param> <param name="value">The new <see cref="T:Gtk.PositionType" />.</param>
<returns>an object of type <see cref="T:Gtk.PositionType" /></returns> <returns>the <see cref="T:Gtk.PositionType" /> of this notebook.</returns>
<remarks>To be added</remarks> <remarks>default is top.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EnablePopup"> <Member MemberName="EnablePopup">
@ -692,10 +693,10 @@ class NotebookSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>enables the popup menu.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param> <param name="value">Use true to enable and false to disable.</param>
<returns>an object of type <see cref="T:System.Boolean" /></returns> <returns>Returns true if the popup menu is enabled and false if not.</returns>
<remarks>To be added</remarks> <remarks>if true and the user clicks with the right mouse button on the tabs, a menu with all the pages will be popped up. </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SelectPage"> <Member MemberName="SelectPage">
@ -823,9 +824,9 @@ class NotebookSample
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>returns the amount of pages in this notebook.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks>returns the amount of pages in this noteboo</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CurrentPageWidget"> <Member MemberName="CurrentPageWidget">

View file

@ -13,7 +13,7 @@
<summary>A tree <paramref name="widget" />.</summary> <summary>A tree <paramref name="widget" />.</summary>
<remarks> <remarks>
<para> <para>
<see cref="T:Gtk.Tree" /> is deprecated and unsupported. It is known to be buggy. To use it, you must define the symbol <paramref name="GTK_ENABLE_BROKEN" /> prior to includng the Gtk# header files. Use <see cref="T:Gtk.Treeview" /> instead. <see cref="T:Gtk.Tree" /> is deprecated and unsupported. It is known to be buggy. To use it, you must define the symbol <paramref name="GTK_ENABLE_BROKEN" /> prior to includng the Gtk# header files. Use <see cref="T:Gtk.TreeView" /> instead.
</para> </para>
<para> <para>
The <see cref="T:Gtk.Tree" /> widget is a container that shows users a list of items, in a tree format complete withbranches and leafnodes. Branches can be expanded to show their child items, or collapsed to hide them. The <see cref="T:Gtk.Tree" /> widget is a container that shows users a list of items, in a tree format complete withbranches and leafnodes. Branches can be expanded to show their child items, or collapsed to hide them.