GtkSharp/doc/en/Gdk/Color.xml
Miguel de Icaza 8e53154449 Update color docs with my new custom files
svn path=/trunk/gtk-sharp/; revision=12053
2003-02-28 07:10:53 +00:00

238 lines
No EOL
8.2 KiB
XML

<Type Name="Color" FullName="Gdk.Color">
<TypeSignature Language="C#" Value="public sealed struct Color;" 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>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gdk.Color Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="pixel">
<MemberSignature Language="C#" Value="public uint pixel;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="red">
<MemberSignature Language="C#" Value="public ushort red;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="green">
<MemberSignature Language="C#" Value="public ushort green;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="blue">
<MemberSignature Language="C#" Value="public ushort blue;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Color (byte r, byte g, byte b);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="r" Type="System.Byte" />
<Parameter Name="g" Type="System.Byte" />
<Parameter Name="b" Type="System.Byte" />
</Parameters>
<Docs>
<summary>Color constructor from RGB byte values</summary>
<param name="r">Red value (0-255)</param>
<param name="g">Green value (0-255)</param>
<param name="b">Blue value (0-255)</param>
<returns>The constructed color structure</returns>
<remarks>
<para>
This constructs the color from three byte values for red,
green and blue. Notice that the Gdk.Color structure
actually uses 16-bit color values, so the byte values are
mapped into the 16-bit value space. This is just a
convenience routine to initialize this structure.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Color (System.Drawing.Color color);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="color" Type="System.Drawing.Color" />
</Parameters>
<Docs>
<summary>Color constructor from a System.Drawing Color</summary>
<param name="color">The color value</param>
<returns>The constructed color structure</returns>
<remarks>
<para>
Use this constructor to create new color values based on
an existing color from a <see cref="T:System.Drawing.Color"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static int Parse (string spec, ref Gdk.Color color);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="spec" Type="System.String" />
<Parameter Name="color" Type="Gdk.Color&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="spec">To be added: an object of type 'string'</param>
<param name="color">To be added: an object of type 'Gdk.Color&amp;'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gdk.Color New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public virtual string ToString ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Equal">
<MemberSignature Language="C#" Value="public bool Equal (Gdk.Color colorb);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="colorb" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="colorb">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public void Free ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gdk.Color Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Hash">
<MemberSignature Language="C#" Value="public uint Hash ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</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.Color</summary>
<returns>The GLib TYpe for the Gdk.Color class.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>