GtkSharp/doc/en/Gtk/StockManager.xml

<Type Name="StockManager" FullName="Gtk.StockManager">
  <TypeSignature Language="C#" Value="public class StockManager" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <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>this class manages the <see cref="T:Gtk.StockItem" />s</summary>
    <remarks />
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <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>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. Use <see cref="M:Gtk.StockManager.AddStatic"/> if 
	  <paramref name="items"/> is persistent and GTK# doesn't need to 
	  copy the array.
	</summary>
        <param name="items">a <see cref="T:Gtk.StockItem" /></param>
        <param name="n_items">a <see cref="T:System.UInt32" />, the number of items in <paramref name="items"/></param>
        <remarks>(TODO: This API doesn't make sense for the underlying C API, because the C API has an option of adding multiple items. Needs clarification.)</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>Same as <see cref="M:Gtk.StockManager.Add"/> but doesn't copy
	  <paramref name="items"/>, so <paramref name="items"/> must persist
	  until application exit.</summary>
        <param name="items">a <see cref="T:Gtk.StockItem" /></param>
        <param name="n_items">a <see cref="T:System.UInt32" /></param>
        <remarks>(TODO:Needs API review; see the Add method also.)</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public StockManager ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Do not use.</summary>
        <returns>a <see cref="T:Gtk.StockManager" /></returns>
        <remarks>Do not use</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>Looks up a <see cref="T:Gtk.StockItem" /></summary>
        <param name="stock_id">the StockId of the <see cref="T:Gtk.StockItem" /> to return.</param>
        <param name="item">the <see cref="T:Gtk.StockItem" /> if found</param>
        <returns>returns <see langword="true" /> if a <see cref="T:Gtk.StockItem" />with the <paramref name="stock_id" />  exists, else returns <see langword="false" />.</returns>
        <remarks />
      </Docs>
    </Member>
  </Members>
</Type>