GtkSharp/doc/en/Gtk/HSV.xml

<Type Name="HSV" FullName="Gtk.HSV">
  <TypeSignature Language="C#" Value="public class HSV : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" 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>A color selector based on hue, saturation, and value.</summary>
    <remarks>TODO: add an example.</remarks>
  </Docs>
  <Base>
    <BaseTypeName>Gtk.Widget</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="SetMetrics">
      <MemberSignature Language="C#" Value="public void SetMetrics (int size, int ring_width);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="size" Type="System.Int32" />
        <Parameter Name="ring_width" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Set the basic size of the hue ring.</summary>
        <param name="size">A <see cref="T:System.Int32" /></param>
        <param name="ring_width">A <see cref="T:System.Int32" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SetColor">
      <MemberSignature Language="C#" Value="public void SetColor (double h, double s, double v);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="h" Type="System.Double" />
        <Parameter Name="s" Type="System.Double" />
        <Parameter Name="v" Type="System.Double" />
      </Parameters>
      <Docs>
        <summary>Sets the color displayed in the widget.</summary>
        <param name="h">A <see cref="T:System.Double" />, the hue</param>
        <param name="s">A <see cref="T:System.Double" />, the saturation</param>
        <param name="v">A <see cref="T:System.Double" />, the value</param>
        <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 HSV (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 HSV, 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 HSV ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Default constructor.</summary>
        <returns>A <see cref="T:Gtk.HSV" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Changed">
      <MemberSignature Language="C#" Value="public event EventHandler Changed;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Fired when the color of this widget changes.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Move">
      <MemberSignature Language="C#" Value="public event Gtk.MoveHandler Move;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.MoveHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Fired when this widget is moved.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ToRgb">
      <MemberSignature Language="C#" Value="public static void ToRgb (double h, double s, double v, out double r, out double g, out double b);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="h" Type="System.Double" />
        <Parameter Name="s" Type="System.Double" />
        <Parameter Name="v" Type="System.Double" />
        <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" />
      </Parameters>
      <Docs>
        <summary>Converts a HSV value to a RGB (red-green-blue) triplet.</summary>
        <param name="h">a <see cref="T:System.Double" />, the hue</param>
        <param name="s">a <see cref="T:System.Double" />, the saturation</param>
        <param name="v">a <see cref="T:System.Double" />, the value</param>
        <param name="r">a <see cref="T:System.Double&amp;" />, red component</param>
        <param name="g">a <see cref="T:System.Double&amp;" />, blue component</param>
        <param name="b">a <see cref="T:System.Double&amp;" />, green component</param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetColor">
      <MemberSignature Language="C#" Value="public void GetColor (out double h, out double s, out double v);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="h" Type="System.Double&amp;" RefType="out" />
        <Parameter Name="s" Type="System.Double&amp;" RefType="out" />
        <Parameter Name="v" Type="System.Double&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>Gets the current color indicated by this widget.</summary>
        <param name="h">a <see cref="T:System.Double&amp;" /></param>
        <param name="s">a <see cref="T:System.Double&amp;" /></param>
        <param name="v">a <see cref="T:System.Double&amp;" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetMetrics">
      <MemberSignature Language="C#" Value="public void GetMetrics (out int size, out int ring_width);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="size" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="ring_width" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>Gets the current size of this widget.</summary>
        <param name="size">a <see cref="T:System.Int32&amp;" /> to fill with the hue ring size.</param>
        <param name="ring_width">a <see cref="T:System.Int32&amp;" /> to fill with the width of the hue ring.</param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="IsAdjusting">
      <MemberSignature Language="C#" Value="public bool IsAdjusting { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
	  An HSV color selector is "adjusting" if multiple rapid 
	  changes are being made to its value, for example, when the user 
	  is adjusting the value with the mouse.  This property tells
	  whether the HSV color selector is being adjusted or not.
	</summary>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks> 
	  Returns true if clients can ignore changes to the color value, since
	  they may be transitory, or false if they should consider the color 
	  value status to be final.
	</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:Gtk.HSV" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnMove">
      <MemberSignature Language="C#" Value="protected virtual void OnMove (Gtk.DirectionType type);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="type" Type="Gtk.DirectionType" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.HSV.Move" /> event.</summary>
        <param name="type">a <see cref="T:Gtk.DirectionType" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HSV.Move" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnChanged">
      <MemberSignature Language="C#" Value="protected virtual void OnChanged ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.HSV.Changed" /> event.</summary>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HSV.Changed" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected HSV (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:Gtk.HSV" /></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>