GtkSharp/doc/en/Gtk/ImageMenuItem.xml
Mike Kestner ab07fa8056 updates to assembly version elements
svn path=/trunk/gtk-sharp/; revision=46164
2005-06-17 18:43:30 +00:00

154 lines
5.7 KiB
XML

<Type Name="ImageMenuItem" FullName="Gtk.ImageMenuItem">
<TypeSignature Language="C#" Maintainer="John Luke" Value="public class ImageMenuItem : Gtk.MenuItem" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.6.0.0</AssemblyVersion>
</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>
<example>
<code lang="C#">
//How to add MenuBar with a Quit stock MenuItem
...
Window win; //if your class derive from Window then call this. istead of win.
MenuBar menuBar
...
AccelGroup grup = new AccelGroup ();
win.AddAccelGroup(grup);
menuFile = new Menu ();
ImageMenuItem quit_item = new ImageMenuItem(Stock.Quit, group);
quit_item.AddAccelerator("activate", grup, new AccelKey(
Gdk.Key.q, Gdk.ModifierType.ControlMask, AccelFlags.Visible));
//OnMenuFileQuit is the Method runned when the event is trigged
quit_item.Activated += new EventHandler (OnMenuFileQuit);
menuFile.Append(quit_item);
MenuItem file_item = new MenuItem("_File");
file_item.Submenu = menuFile;
menuBar.Append(file_item);
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.MenuItem</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<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>
<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>
<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>
<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>
<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>
<value>an object of type <see cref="T:Gtk.Widget" /></value>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="image")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.ImageMenuItem" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ImageMenuItem (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes></Member>
</Members>
</Type>