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

Full docs of Menushell and MenuDirectionType.

Browse source 
svn path=/trunk/gtk-sharp/; revision=12606
This commit is contained in:
Hector E. Gomez Morales 2003-03-17 05:04:39 +00:00
parent 919841f25b
commit a6de3a7745
2 changed files with 86 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/en/Gtk/MenuDirectionType.xml
View file

@ -1,5 +1,5 @@
<Type Name="MenuDirectionType" FullName="Gtk.MenuDirectionType"> <Type Name="MenuDirectionType" FullName="Gtk.MenuDirectionType">
<TypeSignature Language="C#" Value="public sealed struct MenuDirectionType;" Maintainer="auto" /> <TypeSignature Language="C#" Value="public sealed struct MenuDirectionType;" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,12 @@
</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>An enumeration used by MenuShell.</summary>
<remarks>To be added</remarks> <remarks>
<para>
An enumeration used by <see cref="T:Gtk.MenuShell" /> that represents directional movements within a menu.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +38,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To the parent menu shell.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Child"> <Member MemberName="Child">
@ -46,8 +50,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To the submenu, if any, associated with the item.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Next"> <Member MemberName="Next">
@ -58,8 +62,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To the next menu item.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Prev"> <Member MemberName="Prev">
@ -70,8 +74,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To the previous menu item.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">

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

@ -1,5 +1,5 @@
<Type Name="MenuShell" FullName="Gtk.MenuShell"> <Type Name="MenuShell" FullName="Gtk.MenuShell">
<TypeSignature Language="C#" Value="public class MenuShell : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class MenuShell : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,12 @@
</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>A GtkMenuShell is the abstract base class used to derive the GtkMenu and GtkMenuBar subclasses.</summary>
<remarks>To be added</remarks> <remarks>
<para>
A <see cref="T:Gtk.MenuShell" /> is a container of <see cref="T:Gtk.MenuItem" /> objects arranged in a list which can be navigated, selected, and activated by the user to perform application functions. A <see cref="T:Gtk.MenuItem" /> can have a submenu associated with it, allowing for nested hierarchical menus.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Container</BaseTypeName> <BaseTypeName>Gtk.Container</BaseTypeName>
@ -39,9 +43,13 @@
<Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="child" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a new <see cref="T:Gtk.MenuItem" /> to the beginning of the menu shell's item list.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">The <see cref="T:Gtk.MenuItem" /> to add.</param>
<remarks>To be added</remarks> <remarks>Activates the menu item within the menu shell.
<para>
Adds a new <see cref="T:Gtk.MenuItem" /> to the beginning of the menu shell's item list.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Deactivate"> <Member MemberName="Deactivate">
@ -52,8 +60,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Deactivates the menu shell.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Typically this results in the menu shell being erased from the screen.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ActivateItem"> <Member MemberName="ActivateItem">
@ -67,10 +79,14 @@
<Parameter Name="force_deactivate" Type="System.Boolean" /> <Parameter Name="force_deactivate" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Activates the menu item within the menu shell.</summary>
<param name="menu_item">To be added: an object of type 'Gtk.Widget'</param> <param name="menu_item">The <see cref="T:Gtk.MenuItem" /> to activate.</param>
<param name="force_deactivate">To be added: an object of type 'bool'</param> <param name="force_deactivate">If <see cref="langword:true" />, force the deactivation of the menu shell after the menu item is activated.</param>
<remarks>To be added</remarks> <remarks>
<para>
Activates the menu item within the menu shell.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Insert"> <Member MemberName="Insert">
@ -84,10 +100,14 @@
<Parameter Name="position" Type="System.Int32" /> <Parameter Name="position" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a new <see cref="T:Gtk.MenuItem" /> to the menu shell's item list at the position indicated by <paramref name="position"/>.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">The <see cref="T:Gtk.MenuItem" /> to add.</param>
<param name="position">To be added: an object of type 'int'</param> <param name="position">The position in the item list where <paramref name="child" /> is added. Positions are numbered from 0 to n-1.</param>
<remarks>To be added</remarks> <remarks>
<para>
Adds a new <see cref="T:Gtk.MenuItem" /> to the menu shell's item list at the position indicated by position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Deselect"> <Member MemberName="Deselect">
@ -98,8 +118,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Deselects the currently selected item from the menu shell, if any.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Deselects the currently selected item from the menu shell, if any.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Append"> <Member MemberName="Append">
@ -112,9 +136,13 @@
<Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="child" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a new <see cref="T:Gtk.MenuItem" /> to the end of the menu shell's item list.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">The <see cref="T:Gtk.MenuItem" /> to add.</param>
<remarks>To be added</remarks> <remarks>
<para>
Adds a new <see cref="T:Gtk.MenuItem" /> to the end of the menu shell's item list.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SelectItem"> <Member MemberName="SelectItem">
@ -127,9 +155,13 @@
<Parameter Name="menu_item" Type="Gtk.Widget" /> <Parameter Name="menu_item" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Selects the menu item from the menu shell.</summary>
<param name="menu_item">To be added: an object of type 'Gtk.Widget'</param> <param name="menu_item">The <see cref="T:Gtk.MenuItem" /> to select.</param>
<remarks>To be added</remarks> <remarks>
<para>
Selects the menu item from the menu shell.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -166,9 +198,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>A constructor.</summary>
<returns>To be added: an object of type 'Gtk.MenuShell'</returns> <returns>An instance of <see cref="T:Gtk.MenuShell" />.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -189,8 +221,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An action signal that activates the current menu item within the menu shell.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MoveCurrent"> <Member MemberName="MoveCurrent">
@ -199,8 +231,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An action signal which moves the current menu item in the direction specified by <paramref name="direction"/>.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Cancel"> <Member MemberName="Cancel">
@ -209,8 +241,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An action signal which cancels the selection within the menu shell.Causes the <see cref="F:Gtk.MenuShell.SelectionDone"/> signal to be emitted.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SelectionDone"> <Member MemberName="SelectionDone">
@ -219,8 +251,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This signal is emitted when a selection has been completed within a menu shell.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Deactivated"> <Member MemberName="Deactivated">
@ -229,8 +261,8 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This signal is emitted when a menu shell is deactivated.</summary>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">