ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-12-30 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/ItemFactory.xml
	* en/Gtk/MenuShell.xml
	* en/Gtk/MenuEntry.xml
	* en/Gtk/Menu.xml
	* en/Gtk/ItemFactoryEntry.xml
	* en/Gtk/MenuCallback.xml: Docs for menus and menu creation.
	* en/Gtk/Notebook.xml: Docs for a 2.4 change.


svn path=/trunk/gtk-sharp/; revision=38185
This commit is contained in:
Shane Landrum 2004-12-30 16:05:38 +00:00
parent 24f5605366
commit d3fb6e0ae8
8 changed files with 97 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/ChangeLog
View file

@ -1,3 +1,13 @@
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/ItemFactory.xml
* en/Gtk/MenuShell.xml
* en/Gtk/MenuEntry.xml
* en/Gtk/Menu.xml
* en/Gtk/ItemFactoryEntry.xml
* en/Gtk/MenuCallback.xml: Docs for menus and menu creation.
* en/Gtk/Notebook.xml: Docs for a 2.4 change.
2004-12-30 Shane Landrum <epicene@pobox.com> 2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/TreeViewColumn.xml * en/Gtk/TreeViewColumn.xml

36
doc/en/Gtk/ItemFactory.xml
View file

@ -11,7 +11,11 @@
<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> <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>
<Docs> <Docs>
<summary>A factory for menus.</summary> <summary>A factory for menus.</summary>
<remarks /> <remarks>
To use this class, make an array of
<see cref="T:Gtk.MenuEntry"/> objects which describe a menu, then invoke
<see cref="M:Gtk.ItemFactory.CreateMenuEntries"/> to generate the menu.
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Object</BaseTypeName> <BaseTypeName>Gtk.Object</BaseTypeName>
@ -487,10 +491,13 @@
<Parameter Name="path" Type="System.String" /> <Parameter Name="path" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Finds an item factory which has been constructed using the
"&lt;name&gt;" prefix of <paramref name="path"/> as the path argument
building a new item factory.
</summary>
<param name="path">a <see cref="T:System.String" /></param> <param name="path">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gtk.ItemFactory" /></returns> <returns>a <see cref="T:Gtk.ItemFactory" />, or <see langword="null"/></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateMenuEntries"> <Member MemberName="CreateMenuEntries">
@ -504,10 +511,10 @@
<Parameter Name="entries" Type="Gtk.MenuEntry" /> <Parameter Name="entries" Type="Gtk.MenuEntry" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates menu items from a set of entries.</summary>
<param name="n_entries">a <see cref="T:System.UInt32" /></param> <param name="n_entries">a <see cref="T:System.UInt32" />, the number of entries</param>
<param name="entries">a <see cref="T:Gtk.MenuEntry" /></param> <param name="entries">an array of <see cref="T:Gtk.MenuEntry" /> objects</param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateItemsAc"> <Member MemberName="CreateItemsAc">
@ -523,13 +530,14 @@
<Parameter Name="callback_type" Type="System.UInt32" /> <Parameter Name="callback_type" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Creates menu items from entries.</summary>
<param name="n_entries">a <see cref="T:System.UInt32" /></param> <param name="n_entries">a <see cref="T:System.UInt32" />, the number of menu items</param>
<param name="entries">a <see cref="T:Gtk.ItemFactoryEntry" /></param> <param name="entries">a <see cref="T:Gtk.ItemFactoryEntry" />, a list of information about menu items</param>
<param name="callback_data">a <see cref="T:System.IntPtr" /></param> <param name="callback_data">a <see cref="T:System.IntPtr" />, pointer to data that should be passed to
the callback functions of all entries</param>
<param name="callback_type">a <see cref="T:System.UInt32" /></param> <param name="callback_type">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks> <remarks>FIXME: See bugzilla 70887.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

40
doc/en/Gtk/ItemFactoryEntry.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </AssemblyInfo>
<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> <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>
<Docs> <Docs>
<summary>To be added</summary> <summary>Class intended for use with <see cref="T:Gtk.ItemFactory"/>.</summary>
<remarks /> <remarks>FIXME: see bugzilla.ximian.com #70887, which directly concerns this API.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -27,7 +27,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Empty entry.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -41,8 +41,8 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>For internal use only. Do not use.</summary>
<param name="raw">a <see cref="T:IntPtr" /></param> <param name="raw">a <see cref="T:IntPtr" />, pointer to the underlying C data.</param>
<returns>a <see cref="T:Gtk.ItemFactoryEntry" /></returns> <returns>a <see cref="T:Gtk.ItemFactoryEntry" /></returns>
<remarks /> <remarks />
</Docs> </Docs>
@ -56,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The path of the item.</summary>
<remarks /> <remarks>For example, "/File/_Open", where the "O" should be a mnemonic underline.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Accelerator"> <Member MemberName="Accelerator">
@ -69,8 +69,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The accelerator key for this item.</summary>
<remarks /> <remarks>For example, "<control>O".</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CallbackAction"> <Member MemberName="CallbackAction">
@ -82,8 +82,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A callback function to run when this item is activated.</summary>
<remarks /> <remarks>NOTE: The API doesn't support the actual code here.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ItemType"> <Member MemberName="ItemType">
@ -95,9 +95,21 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Type of item to add.</summary>
<remarks /> <remarks>Possible values:
"&lt;Title&gt;" creates a title item,
"&lt;Item&gt;" creates a simple item,
"&lt;ImageItem&gt;" creates an item holding an image,
"&lt;StockItem&gt;" creates an item holding a stock image,
"&lt;CheckItem&gt;" creates a check item,
"&lt;ToggleItem&gt;" creates a toggle item,
"&lt;RadioItem&gt;" creates a radio item,
&lt;path&gt; for the path of a radio item to link against,
"&lt;Separator&gt;" creates a separator,
"&lt;Tearoff&gt;" creates a tearoff separator,
"&lt;Branch&gt;" creates an item to hold sub items,
"&lt;LastBranch&gt;" creates a right justified item to hold sub items.</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

21
doc/en/Gtk/Menu.xml
View file

@ -496,9 +496,9 @@ class PopupSample
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The number of the monitor on which the menu should be popped up.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Attach"> <Member MemberName="Attach">
@ -515,13 +515,22 @@ class PopupSample
<Parameter Name="bottom_attach" Type="System.UInt32" /> <Parameter Name="bottom_attach" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a new <see cref="T:Gtk.MenuItem"/> to a (table) menu.</summary>
<param name="child">a <see cref="T:Gtk.Widget" /></param> <param name="child">a <see cref="T:Gtk.Widget" />, should be a <see cref="T:Gtk.MenuItem"/></param>
<param name="left_attach">a <see cref="T:System.UInt32" /></param> <param name="left_attach">a <see cref="T:System.UInt32" /></param>
<param name="right_attach">a <see cref="T:System.UInt32" /></param> <param name="right_attach">a <see cref="T:System.UInt32" /></param>
<param name="top_attach">a <see cref="T:System.UInt32" /></param> <param name="top_attach">a <see cref="T:System.UInt32" /></param>
<param name="bottom_attach">a <see cref="T:System.UInt32" /></param> <param name="bottom_attach">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks> <remarks>
<para>The number of 'cells' that
an item will occupy is specified by <paramref name="left_attach"/>,
<paramref name="right_attach"/>, <paramref name="top_attach"/> and
<paramref name="bottom_attach"/>. These each represent the leftmost,
rightmost, uppermost and lower column and row numbers of the table.
(Columns and rows are indexed from zero).</para>
<para>Note that this function is not related to <see cref="M:Gtk.Menu.Detach"/>.</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Item"> <Member MemberName="Item">
@ -541,4 +550,4 @@ class PopupSample
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/MenuCallback.xml
View file

@ -9,8 +9,8 @@
</AssemblyInfo> </AssemblyInfo>
<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> <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>
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks>To be added</remarks> <remarks>Do not use.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -31,4 +31,4 @@
<Parameters> <Parameters>
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
</Type> </Type>

31
doc/en/Gtk/MenuEntry.xml
View file

@ -9,8 +9,11 @@
</AssemblyInfo> </AssemblyInfo>
<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> <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>
<Docs> <Docs>
<summary>To be added</summary> <summary>Class for use with <see cref="T:Gtk.ItemFactory"/> in generating menus.</summary>
<remarks>To be added</remarks> <remarks>
See <see cref="T:Gtk.ItemFactory"/> for more details.
FIXME: see bugzilla.ximian.com #70887, which directly concerns this API.
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +30,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>An empty menu entry.</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Path"> <Member MemberName="Path">
@ -40,8 +43,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The path of this menu item.</summary>
<remarks>To be added</remarks> <remarks>For example, "/File/_Open", where the "O" should be a mnemonic underline.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Accelerator"> <Member MemberName="Accelerator">
@ -53,8 +56,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>An accelerator key sequence</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -67,10 +70,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>For internal use only. Do not use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C object.</param>
<returns>a <see cref="T:Gtk.MenuEntry" /></returns> <returns>a <see cref="T:Gtk.MenuEntry" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="widget"> <Member MemberName="widget">
@ -81,10 +84,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The widget related to this menu entry.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

4
doc/en/Gtk/MenuShell.xml
View file

@ -377,8 +377,6 @@
<Docs> <Docs>
<summary>Default handler for the <see cref="M:Gtk.MenuShell.Canceled" /> event.</summary> <summary>Default handler for the <see cref="M:Gtk.MenuShell.Canceled" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.MenuShell.Canceled" /> event.</remarks> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.MenuShell.Canceled" /> event.</remarks>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Cancel"> <Member MemberName="Cancel">
@ -394,4 +392,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/Notebook.xml
View file

@ -875,9 +875,9 @@ the label of a menu doesn't have to be a <see cref="T:Gtk.Label" />. it can be a
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether tabs should have homogeneous sizes.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PrependPageMenu"> <Member MemberName="PrependPageMenu">
@ -1048,4 +1048,4 @@ Don't forget to call the Show method on the widget or else the new page will not
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>