GtkSharp/doc/en/Gtk/MenuShell.xml
Joshua Tauberer 9d0a50175b Updated GtkSharp docs for monodoc's needs
svn path=/trunk/gtk-sharp/; revision=16463
2003-07-21 00:13:00 +00:00

300 lines
12 KiB
XML

<Type Name="MenuShell" FullName="Gtk.MenuShell">
<TypeSignature Language="C#" Value="public class MenuShell : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</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>A GtkMenuShell is the abstract base class used to derive the GtkMenu and GtkMenuBar subclasses.</summary>
<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>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Prepend">
<MemberSignature Language="C#" Value="public void Prepend (Gtk.Widget child);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="child" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>Adds a new <see cref="T:Gtk.MenuItem" /> to the beginning of the menu shell's item list.</summary>
<param name="child">The <see cref="T:Gtk.MenuItem" /> to add.</param>
<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>
</Member>
<Member MemberName="Deactivate">
<MemberSignature Language="C#" Value="public void Deactivate ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Deactivates the menu shell.</summary>
<remarks>
<para>
Typically this results in the menu shell being erased from the screen.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ActivateItem">
<MemberSignature Language="C#" Value="public void ActivateItem (Gtk.Widget menu_item, bool force_deactivate);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="menu_item" Type="Gtk.Widget" />
<Parameter Name="force_deactivate" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Activates the menu item within the menu shell.</summary>
<param name="menu_item">The <see cref="T:Gtk.MenuItem" /> to activate.</param>
<param name="force_deactivate">If <see langword="true" />, force the deactivation of the menu shell after the menu item is activated.</param>
<remarks>
<para>
Activates the menu item within the menu shell.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Insert">
<MemberSignature Language="C#" Value="public void Insert (Gtk.Widget child, int position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="child" Type="Gtk.Widget" />
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<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">The <see cref="T:Gtk.MenuItem" /> to add.</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>
<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>
</Member>
<Member MemberName="Deselect">
<MemberSignature Language="C#" Value="public void Deselect ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Deselects the currently selected item from the menu shell, if any.</summary>
<remarks>
<para>
Deselects the currently selected item from the menu shell, if any.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Append">
<MemberSignature Language="C#" Value="public void Append (Gtk.Widget child);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="child" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>Adds a new <see cref="T:Gtk.MenuItem" /> to the end of the menu shell's item list.</summary>
<param name="child">The <see cref="T:Gtk.MenuItem" /> to add.</param>
<remarks>
<para>
Adds a new <see cref="T:Gtk.MenuItem" /> to the end of the menu shell's item list.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SelectItem">
<MemberSignature Language="C#" Value="public void SelectItem (Gtk.Widget menu_item);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="menu_item" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>Selects the menu item from the menu shell.</summary>
<param name="menu_item">The <see cref="T:Gtk.MenuItem" /> to select.</param>
<remarks>
<para>
Selects the menu item from the menu shell.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MenuShell (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of MenuShell, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected MenuShell ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>A constructor.</summary>
<returns>An instance of <see cref="T:Gtk.MenuShell" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.MenuShell</summary>
<returns>The GLib Type for the Gtk.MenuShell class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ActivateCurrent">
<MemberSignature Language="C#" Value="public event GtkSharp.ActivateCurrentHandler ActivateCurrent;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.ActivateCurrentHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>An action signal that activates the current menu item within the menu shell.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MoveCurrent">
<MemberSignature Language="C#" Value="public event GtkSharp.MoveCurrentHandler MoveCurrent;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.MoveCurrentHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>An action signal which moves the current menu item in the direction specified by <paramref name="direction" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public event EventHandler Cancel;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<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 />
</Docs>
</Member>
<Member MemberName="SelectionDone">
<MemberSignature Language="C#" Value="public event EventHandler SelectionDone;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>This signal is emitted when a selection has been completed within a menu shell.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Deactivated">
<MemberSignature Language="C#" Value="public event EventHandler Deactivated;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>This signal is emitted when a menu shell is deactivated.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected MenuShell (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of MenuShell, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.MenuShell" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SelectFirst">
<MemberSignature Language="C#" Value="public void SelectFirst (bool search_sensitive);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="search_sensitive" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="search_sensitive">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>