GtkSharp/doc/en/Gtk/ImageMenuItem.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

165 lines
6.6 KiB
XML

<Type Name="ImageMenuItem" FullName="Gtk.ImageMenuItem">
<TypeSignature Language="C#" Value="public class ImageMenuItem : Gtk.MenuItem, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="John Luke" />
<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 <see cref="T:Gtk.MenuItem"/> with an icon.</summary>
<remarks>
<para><see cref="T:Gtk.ImageMenuItem"/> is a <see cref="T:Gtk.MenuItem"/> which has an icon next to the text label.</para>
<para>Note that the user can disable display of menu icons, so make sure to still fill in the text label.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.MenuItem</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="NewWithLabel">
<MemberSignature Language="C#" Value="public static Gtk.ImageMenuItem NewWithLabel (string label);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.ImageMenuItem</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.ImageMenuItem"/> containing a label.</summary>
<param name="label">an object of type <see cref="T:System.String"/></param>
<returns>an object of type <see cref="T:Gtk.ImageMenuItem"/></returns>
<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 ImageMenuItem (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 ImageMenuItem, 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="public ImageMenuItem ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates a new <see cref="T:Gtk.ImageMenuItem"/>.</summary>
<returns>an object of type <see cref="T:Gtk.ImageMenuItem"/></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ImageMenuItem (string stock_id, Gtk.AccelGroup accel_group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.ImageMenuItem"/> containing the image and text from a stock item.</summary>
<param name="stock_id">an object of type <see cref="T:System.String"/></param>
<param name="accel_group">an object of type <see cref="T:Gtk.AccelGroup"/></param>
<returns>an object of type <see cref="T:Gtk.ImageMenuItem"/></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ImageMenuItem (string label);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.ImageMenuItem"/> containing a label.</summary>
<param name="label">an object of type <see cref="T:System.String"/></param>
<returns>an object of type <see cref="T:Gtk.ImageMenuItem"/></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 <see cref="T:GLib Type"/> for <see cref="T:Gtk.ImageMenuItem"/></summary>
<returns>The <see cref="T:GLib Type"/> for the <see cref="T:Gtk.ImageMenuItem"/> class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Image">
<MemberSignature Language="C#" Value="public Gtk.Widget Image { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Child widget to appear next to the menu text.</summary>
<param name="value">an object of type <see cref="T:Gtk.Widget"/></param>
<returns>an object of type <see cref="T:Gtk.Widget"/></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ImageMenuItem (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 ImageMenuItem, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ImageMenuItem" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>