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. svn path=/trunk/gtk-sharp/; revision=38185
This commit is contained in:
parent
24f5605366
commit
d3fb6e0ae8
8 changed files with 97 additions and 57 deletions
|
@ -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>
|
||||
|
||||
* en/Gtk/TreeViewColumn.xml
|
||||
|
|
|
@ -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>
|
||||
<Docs>
|
||||
<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>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Object</BaseTypeName>
|
||||
|
@ -487,10 +491,13 @@
|
|||
<Parameter Name="path" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Finds an item factory which has been constructed using the
|
||||
"<name>" 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>
|
||||
<returns>a <see cref="T:Gtk.ItemFactory" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<returns>a <see cref="T:Gtk.ItemFactory" />, or <see langword="null"/></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateMenuEntries">
|
||||
|
@ -504,10 +511,10 @@
|
|||
<Parameter Name="entries" Type="Gtk.MenuEntry" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="n_entries">a <see cref="T:System.UInt32" /></param>
|
||||
<param name="entries">a <see cref="T:Gtk.MenuEntry" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates menu items from a set of entries.</summary>
|
||||
<param name="n_entries">a <see cref="T:System.UInt32" />, the number of entries</param>
|
||||
<param name="entries">an array of <see cref="T:Gtk.MenuEntry" /> objects</param>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CreateItemsAc">
|
||||
|
@ -523,12 +530,13 @@
|
|||
<Parameter Name="callback_type" Type="System.UInt32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="n_entries">a <see cref="T:System.UInt32" /></param>
|
||||
<param name="entries">a <see cref="T:Gtk.ItemFactoryEntry" /></param>
|
||||
<param name="callback_data">a <see cref="T:System.IntPtr" /></param>
|
||||
<summary>Creates menu items from entries.</summary>
|
||||
<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" />, a list of information about menu items</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>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks>FIXME: See bugzilla 70887.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -10,8 +10,8 @@
|
|||
</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>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks />
|
||||
<summary>Class intended for use with <see cref="T:Gtk.ItemFactory"/>.</summary>
|
||||
<remarks>FIXME: see bugzilla.ximian.com #70887, which directly concerns this API.</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.ValueType</BaseTypeName>
|
||||
|
@ -27,7 +27,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Empty entry.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
|
@ -41,8 +41,8 @@
|
|||
<Parameter Name="raw" Type="System.IntPtr" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="raw">a <see cref="T:IntPtr" /></param>
|
||||
<summary>For internal use only. Do not use.</summary>
|
||||
<param name="raw">a <see cref="T:IntPtr" />, pointer to the underlying C data.</param>
|
||||
<returns>a <see cref="T:Gtk.ItemFactoryEntry" /></returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
|
@ -56,8 +56,8 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks />
|
||||
<summary>The path of the item.</summary>
|
||||
<remarks>For example, "/File/_Open", where the "O" should be a mnemonic underline.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Accelerator">
|
||||
|
@ -69,8 +69,8 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks />
|
||||
<summary>The accelerator key for this item.</summary>
|
||||
<remarks>For example, "<control>O".</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CallbackAction">
|
||||
|
@ -82,8 +82,8 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks />
|
||||
<summary>A callback function to run when this item is activated.</summary>
|
||||
<remarks>NOTE: The API doesn't support the actual code here.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ItemType">
|
||||
|
@ -95,8 +95,20 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks />
|
||||
<summary>Type of item to add.</summary>
|
||||
<remarks>Possible values:
|
||||
"<Title>" creates a title item,
|
||||
"<Item>" creates a simple item,
|
||||
"<ImageItem>" creates an item holding an image,
|
||||
"<StockItem>" creates an item holding a stock image,
|
||||
"<CheckItem>" creates a check item,
|
||||
"<ToggleItem>" creates a toggle item,
|
||||
"<RadioItem>" creates a radio item,
|
||||
<path> for the path of a radio item to link against,
|
||||
"<Separator>" creates a separator,
|
||||
"<Tearoff>" creates a tearoff separator,
|
||||
"<Branch>" creates an item to hold sub items,
|
||||
"<LastBranch>" creates a right justified item to hold sub items.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -496,9 +496,9 @@ class PopupSample
|
|||
<ReturnType>System.Int32</ReturnType>
|
||||
</ReturnValue>
|
||||
<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>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Attach">
|
||||
|
@ -515,13 +515,22 @@ class PopupSample
|
|||
<Parameter Name="bottom_attach" Type="System.UInt32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="child">a <see cref="T:Gtk.Widget" /></param>
|
||||
<summary>Adds a new <see cref="T:Gtk.MenuItem"/> to a (table) menu.</summary>
|
||||
<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="right_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>
|
||||
<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>
|
||||
</Member>
|
||||
<Member MemberName="Item">
|
||||
|
|
|
@ -9,8 +9,8 @@
|
|||
</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>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Do not use.</summary>
|
||||
<remarks>Do not use.</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Delegate</BaseTypeName>
|
||||
|
|
|
@ -9,8 +9,11 @@
|
|||
</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>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Class for use with <see cref="T:Gtk.ItemFactory"/> in generating menus.</summary>
|
||||
<remarks>
|
||||
See <see cref="T:Gtk.ItemFactory"/> for more details.
|
||||
FIXME: see bugzilla.ximian.com #70887, which directly concerns this API.
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.ValueType</BaseTypeName>
|
||||
|
@ -27,8 +30,8 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>An empty menu entry.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Path">
|
||||
|
@ -40,8 +43,8 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The path of this menu item.</summary>
|
||||
<remarks>For example, "/File/_Open", where the "O" should be a mnemonic underline.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Accelerator">
|
||||
|
@ -53,8 +56,8 @@
|
|||
<Parameters>
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>An accelerator key sequence</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="New">
|
||||
|
@ -67,10 +70,10 @@
|
|||
<Parameter Name="raw" Type="System.IntPtr" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
||||
<summary>For internal use only. Do not use.</summary>
|
||||
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C object.</param>
|
||||
<returns>a <see cref="T:Gtk.MenuEntry" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="widget">
|
||||
|
@ -81,9 +84,9 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The widget related to this menu entry.</summary>
|
||||
<returns>a <see cref="T:Gtk.Widget" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
@ -377,8 +377,6 @@
|
|||
<Docs>
|
||||
<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>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Cancel">
|
||||
|
|
|
@ -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>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Whether tabs should have homogeneous sizes.</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="PrependPageMenu">
|
||||
|
|
Loading…
Reference in a new issue