GtkSharp/doc/en/Pango/Color.xml

175 lines
6.6 KiB
XML
Raw Normal View History

<Type Name="Color" FullName="Pango.Color">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct Color" />
<AssemblyInfo>
<AssemblyName>pango-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.0.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 structure is used to represent a color in an uncalibrated RGB colorspace.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Pango.Color Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Pango.Color</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns an empty <see cref="T:Pango.Color" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Pango.Color New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Color</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Pango.Color" /></returns>
<remarks>This is an internal method, and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public bool Parse (string spec);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="spec" Type="System.String" />
</Parameters>
<Docs>
<summary>Fill in the fields of a color from a string specification.</summary>
<param name="spec"> a string specifying the new color</param>
<returns>
<see langword="true" /> if parsing of the specifier succeeded, otherwise false.</returns>
<remarks>The string can either one of a large set of standard names. (Taken from the X11 rgb.txt file), or it can be a hex value in the form '#rgb' '#rrggbb' '#rrrgggbbb' or '#rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the red, green, and blue components of the color, respectively. (White in the four forms is '#fff' '#ffffff' '#fffffffff' and '#ffffffffffff')</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>Frees a color allocated by <see cref="M:Pango.Color.Copy()" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Pango.Color Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Color</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a copy of the <see cref="T:Pango.Color" />.</summary>
<returns>an object of type <see cref="T:Pango.Color" /></returns>
<remarks />
</Docs>
</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:Pango.Color" />.</remarks>
</Docs>
</Member>
<Member MemberName="Red">
<MemberSignature Language="C#" Value="public ushort Red;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The red component of the color.</summary>
<remarks>This is a value between 0 and 65535, with 65535 indicating full intensity.</remarks>
</Docs>
</Member>
<Member MemberName="Green">
<MemberSignature Language="C#" Value="public ushort Green;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The green component of the color.</summary>
<remarks>This is a value between 0 and 65535, with 65535 indicating full intensity.</remarks>
</Docs>
</Member>
<Member MemberName="Blue">
<MemberSignature Language="C#" Value="public ushort Blue;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The blue component of the color.</summary>
<remarks>This is a value between 0 and 65535, with 65535 indicating full intensity.</remarks>
</Docs>
</Member>
<Member MemberName="op_Explicit">
<MemberSignature Language="C#" Value="public static GLib.Value op_Explicit (Pango.Color boxed);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.Value</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="boxed" Type="Pango.Color" />
</Parameters>
<Docs>
<param name="boxed">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Explicit">
<MemberSignature Language="C#" Value="public static Pango.Color op_Explicit (GLib.Value val);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Pango.Color</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="GLib.Value" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>