GtkSharp/doc/en/Gnome/ColorPicker.xml
Mike Kestner f0c0542224 revert the last patch from shane that caused large diffs rerunning the updater
svn path=/trunk/gtk-sharp/; revision=38506
2005-01-07 20:55:53 +00:00

366 lines
15 KiB
XML

<Type Name="ColorPicker" FullName="Gnome.ColorPicker">
<TypeSignature Language="C#" Value="public class ColorPicker : Gtk.Button, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-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>A button for selecting a color.</summary>
<remarks>ColorPicker provides a button for selecting a color. When pressed, a dialog is opened allowing the user to select a color.</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Button</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="SetD">
<MemberSignature Language="C#" Value="public void SetD (double r, double g, double b, double a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.Double" />
<Parameter Name="g" Type="System.Double" />
<Parameter Name="b" Type="System.Double" />
<Parameter Name="a" Type="System.Double" />
</Parameters>
<Docs>
<summary>Set the color in the widget.</summary>
<param name="r">The red value to set.</param>
<param name="g">The green value to set.</param>
<param name="b">The blue value to set.</param>
<param name="a">The alpha value to set.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetI8">
<MemberSignature Language="C#" Value="public void SetI8 (byte r, byte g, byte b, byte a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.Byte" />
<Parameter Name="g" Type="System.Byte" />
<Parameter Name="b" Type="System.Byte" />
<Parameter Name="a" Type="System.Byte" />
</Parameters>
<Docs>
<summary>Set the color in the widget.</summary>
<param name="r">The red value to set.</param>
<param name="g">The green value to set.</param>
<param name="b">The blue value to set.</param>
<param name="a">The alpha value to set.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetI16">
<MemberSignature Language="C#" Value="public void SetI16 (ushort r, ushort g, ushort b, ushort a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.UInt16" />
<Parameter Name="g" Type="System.UInt16" />
<Parameter Name="b" Type="System.UInt16" />
<Parameter Name="a" Type="System.UInt16" />
</Parameters>
<Docs>
<summary>Set the color in the widget.</summary>
<param name="r">The red value to set.</param>
<param name="g">The green value to set.</param>
<param name="b">The blue value to set.</param>
<param name="a">The alpha value to set.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override 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 ColorPicker (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 ColorPicker, 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 ColorPicker ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Create a new ColorPicker widget.</summary>
<returns>To be added: an object of type 'Gnome.ColorPicker'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Green">
<MemberSignature Language="C#" Value="public uint Green { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The green value for the color in the widget.</summary>
<param name="value">Value of the color in the range from 0 to 65535. </param>
<returns>The current value of the channel.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Alpha">
<MemberSignature Language="C#" Value="public uint Alpha { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The alpha value for the color in the widget.</summary>
<param name="value">Value of the color in the range from 0 to 65535. </param>
<returns>The current value of the channel.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public string Title { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The title to be displayed on the color selection dialog.</summary>
<param name="value">The text to use.</param>
<returns>Current text to be used for the color selection dialog.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Dither">
<MemberSignature Language="C#" Value="public bool Dither { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether the sample is dithered or simply a solid color.</summary>
<param name="value">Whether to dither or not.</param>
<returns>Current dither settings for the widget.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Blue">
<MemberSignature Language="C#" Value="public uint Blue { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The blue value for the color in the widget.</summary>
<param name="value">Value of the color in the range from 0 to 65535. </param>
<returns>The current value of the channel.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UseAlpha">
<MemberSignature Language="C#" Value="public bool UseAlpha { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Enable/Disable support for an alpha channel for the color.</summary>
<param name="value">Whether to support an alpha channel or not.</param>
<returns>Curren rule for the use of the alpha channel.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Red">
<MemberSignature Language="C#" Value="public uint Red { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The red value for the color in the widget.</summary>
<param name="value">Value of the color in the range from 0 to 65535.</param>
<returns>The current value of the channel.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColorSet">
<MemberSignature Language="C#" Value="public event Gnome.ColorSetHandler ColorSet;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gnome.ColorSetHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when a color is selected in the color dialog.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetI16">
<MemberSignature Language="C#" Value="public void GetI16 (out ushort r, out ushort g, out ushort b, out ushort a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.UInt16&amp;" RefType="out" />
<Parameter Name="g" Type="System.UInt16&amp;" RefType="out" />
<Parameter Name="b" Type="System.UInt16&amp;" RefType="out" />
<Parameter Name="a" Type="System.UInt16&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Get the UInt16s for the current color in the widget.</summary>
<param name="r">Location to store the red value.</param>
<param name="g">Location to store the green value.</param>
<param name="b">Location to store the blue value.</param>
<param name="a">Location to store the alpha value.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetD">
<MemberSignature Language="C#" Value="public void GetD (out double r, out double g, out double b, out double a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.Double&amp;" RefType="out" />
<Parameter Name="g" Type="System.Double&amp;" RefType="out" />
<Parameter Name="b" Type="System.Double&amp;" RefType="out" />
<Parameter Name="a" Type="System.Double&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Get the doubles for the current color in the widget.</summary>
<param name="r">Location to store the red value.</param>
<param name="g">Location to store the green value.</param>
<param name="b">Location to store the blue value.</param>
<param name="a">Location to store the alpha value.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetI8">
<MemberSignature Language="C#" Value="public void GetI8 (out byte r, out byte g, out byte b, out byte a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="g" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="b" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="a" Type="System.Byte&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Get the bytes for the current color in the widget.</summary>
<param name="r">Location to store the red value.</param>
<param name="g">Location to store the green value.</param>
<param name="b">Location to store the blue value.</param>
<param name="a">Location to store the alpha value.</param>
<remarks>To be added</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>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.ColorPicker" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnColorSet">
<MemberSignature Language="C#" Value="protected virtual void OnColorSet (uint r, uint g, uint b, uint a);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="r" Type="System.UInt32" />
<Parameter Name="g" Type="System.UInt32" />
<Parameter Name="b" Type="System.UInt32" />
<Parameter Name="a" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gnome.ColorPicker.ColorSet" /> event.</summary>
<param name="r">a <see cref="T:System.UInt32" /></param>
<param name="g">a <see cref="T:System.UInt32" /></param>
<param name="b">a <see cref="T:System.UInt32" /></param>
<param name="a">a <see cref="T:System.UInt32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.ColorPicker.ColorSet" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ColorPicker (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gnome.ColorPicker" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
</Members>
</Type>