GtkSharp/doc/en/Gdk/Colormap.xml

224 lines
8.8 KiB
XML
Raw Normal View History

<Type Name="Colormap" FullName="Gdk.Colormap">
<TypeSignature Language="C#" Value="public class Colormap : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="AllocColors">
<MemberSignature Language="C#" Value="public int AllocColors (Gdk.Color colors, int ncolors, bool writeable, bool best_match, bool success);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="colors" Type="Gdk.Color" />
<Parameter Name="ncolors" Type="System.Int32" />
<Parameter Name="writeable" Type="System.Boolean" />
<Parameter Name="best_match" Type="System.Boolean" />
<Parameter Name="success" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="colors">To be added: an object of type 'Gdk.Color'</param>
<param name="ncolors">To be added: an object of type 'int'</param>
<param name="writeable">To be added: an object of type 'bool'</param>
<param name="best_match">To be added: an object of type 'bool'</param>
<param name="success">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FreeColors">
<MemberSignature Language="C#" Value="public void FreeColors (Gdk.Color colors, int ncolors);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="colors" Type="Gdk.Color" />
<Parameter Name="ncolors" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="colors">To be added: an object of type 'Gdk.Color'</param>
<param name="ncolors">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="QueryColor">
<MemberSignature Language="C#" Value="public void QueryColor (ulong pixel, Gdk.Color result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pixel" Type="System.UInt64" />
<Parameter Name="result" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixel">To be added: an object of type 'ulong'</param>
<param name="result">To be added: an object of type 'Gdk.Color'</param>
<remarks>To be added</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 Colormap (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 Colormap, 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 Colormap (Gdk.Visual visual, bool allocate);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="visual" Type="Gdk.Visual" />
<Parameter Name="allocate" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="visual">To be added: an object of type 'Gdk.Visual'</param>
<param name="allocate">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'Gdk.Colormap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Colormap ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Colormap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="System">
<MemberSignature Language="C#" Value="public static Gdk.Colormap System { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Colormap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Colormap'</returns>
<remarks>To be added</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 Gdk.Colormap</summary>
<returns>The GLib Type for the Gdk.Colormap class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Visual">
<MemberSignature Language="C#" Value="public Gdk.Visual Visual { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Visual</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Visual'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Colormap (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 Colormap, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gdk.Colormap" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AllocColor">
<MemberSignature Language="C#" Value="public bool AllocColor (ref Gdk.Color color, bool writeable, bool best_match);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="color" Type="Gdk.Color&amp;" RefType="ref" />
<Parameter Name="writeable" Type="System.Boolean" />
<Parameter Name="best_match" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="color">To be added: an object of type 'Gdk.Color&amp;'</param>
<param name="writeable">To be added: an object of type 'bool'</param>
<param name="best_match">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Screen">
<MemberSignature Language="C#" Value="public Gdk.Screen Screen { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Screen</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>