GtkSharp/doc/en/Gtk/StockManager.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

138 lines
5.4 KiB
XML

<Type Name="StockManager" FullName="Gtk.StockManager">
<TypeSignature Language="C#" Value="public class StockManager" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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>this class manages the <see cref="T:Gtk.StockItem" />s</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public static void Add (Gtk.StockItem[] items);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="items" Type="Gtk.StockItem[]" />
</Parameters>
<Docs>
<summary>Registers each of the stock items in <paramref name="items" />.
If an item already exists with the same stock ID as one of the
<paramref name="items" />, the old item gets replaced. The stock
items are copied, so GTK+ does not hold any pointer into
<paramref name="items" /> and <paramref name="items" /> can be
freed.
</summary>
<param name="items">an array of <see cref="T:Gtk.StockItem" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StockManager ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Do not use.</summary>
<remarks>Do not use</remarks>
</Docs>
</Member>
<Member MemberName="AddStatic">
<MemberSignature Language="C#" Value="public static void AddStatic (Gtk.StockItem items, uint n_items);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="items" Type="Gtk.StockItem" />
<Parameter Name="n_items" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Obsolete, do not use.</summary>
<param name="items">a <see cref="T:Gtk.StockItem" /></param>
<param name="n_items">a <see cref="T:System.UInt32" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Lookup">
<MemberSignature Language="C#" Value="public static bool Lookup (string stock_id, ref Gtk.StockItem item);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="item" Type="Gtk.StockItem&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>Finds a stock item by stock_id.</summary>
<param name="stock_id">a <see cref="T:System.String" /></param>
<param name="item">a <see cref="T:Gtk.StockItem" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>See also <see cref="M:Gtk.StockManager.LookupItem" /></remarks>
</Docs>
</Member>
<Member MemberName="LookupItem">
<MemberSignature Language="C#" Value="public static bool LookupItem (string stock_id, out Gtk.StockItem item);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="item" Type="Gtk.StockItem&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Finds a stock item by stock_id.</summary>
<param name="stock_id">a <see cref="T:System.String" /></param>
<param name="item">a <see cref="T:Gtk.StockItem" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public static void Add (Gtk.StockItem items, uint n_items);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="items" Type="Gtk.StockItem" />
<Parameter Name="n_items" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Adds a stock item.</summary>
<param name="items">a <see cref="T:Gtk.StockItem" /></param>
<param name="n_items">a <see cref="T:System.UInt32" /></param>
<remarks>This signature is obsolete, but preserved for backward compatibility. Use the single parameter overload for new code.</remarks>
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public static void Add (Gtk.StockItem item);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="item" Type="Gtk.StockItem" />
</Parameters>
<Docs>
<summary>Adds a stock item.</summary>
<param name="item">a <see cref="T:Gtk.StockItem" /></param>
<remarks />
</Docs>
</Member>
</Members>
</Type>