GtkSharp/doc/en/Gtk/ColorSelection.xml

<Type Name="ColorSelection" FullName="Gtk.ColorSelection">
  <TypeSignature Language="C#" Maintainer="Lee Mallabone" Value="public class ColorSelection : Gtk.VBox" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ColorSelection extends Gtk.VBox" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
  </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>
  <Base>
    <BaseTypeName>Gtk.VBox</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Docs>
    <summary>A widget for selecting a color.</summary>
    <remarks>
      <para>The ColorSelection consists of a color wheel and number of sliders and entry boxes for color parameters such as hue, saturation, value, red, green, blue, and opacity. It is found on the standard color selection dialog box, <see cref="Gtk.ColorSelectionDialog" />.</para>
      <para>This widget displays the 'selected' color as well as the previously selected color.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ColorSelection ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>The main way to create a new ColorSelection</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ColorSelection (IntPtr raw);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="raw">Pointer to the C object.</param>
        <summary>Internal constructor</summary>
        <remarks>
          <para>This is an internal constructor, and should not be used by user code.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ColorChanged">
      <MemberSignature Language="C#" Value="public event EventHandler ColorChanged;" />
      <MemberSignature Language="ILAsm" Value=".event class System.EventHandler ColorChanged" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("color-changed")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>This event is raised when the current color changes in the ColorSelection.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="CurrentAlpha">
      <MemberSignature Language="C#" Value="public ushort CurrentAlpha { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int16 CurrentAlpha" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("current-alpha")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.UInt16</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage the current alpha value of the ColorSelection.</summary>
        <value>The existing opacity of this ColorSelection.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="CurrentColor">
      <MemberSignature Language="C#" Value="public Gdk.Color CurrentColor { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Gdk.Color CurrentColor" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("current-color")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage the current color of the ColorSelection.</summary>
        <value>The currently selected color in this ColorSelection.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="CurrentRgba">
      <MemberSignature Language="C#" Value="public Gdk.RGBA CurrentRgba { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Gdk.RGBA CurrentRgba" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("current-rgba")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Gdk.RGBA</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="GetCurrentRgba">
      <MemberSignature Language="C#" Value="public void GetCurrentRgba (Gdk.RGBA rgba);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetCurrentRgba(valuetype Gdk.RGBA rgba) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="rgba" Type="Gdk.RGBA" />
      </Parameters>
      <Docs>
        <param name="rgba">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="GetPreviousRgba">
      <MemberSignature Language="C#" Value="public void GetPreviousRgba (Gdk.RGBA rgba);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetPreviousRgba(valuetype Gdk.RGBA rgba) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="rgba" Type="Gdk.RGBA" />
      </Parameters>
      <Docs>
        <param name="rgba">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
      <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:Gtk.ColorSelection" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HasOpacityControl">
      <MemberSignature Language="C#" Value="public bool HasOpacityControl { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool HasOpacityControl" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("has-opacity-control")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage whether or not opacity is part of the ColorSelection.</summary>
        <value>
          <see langword="true" /> if the user can edit opacity, <see langword="false" /> otherwise.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="HasPalette">
      <MemberSignature Language="C#" Value="public bool HasPalette { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool HasPalette" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("has-palette")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage whether or not the ColorSelection displays a palette.</summary>
        <value>
          <see langword="true" /> if a palette is currently part of the ColorSelection, <see langword="false" /> otherwise.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="IsAdjusting">
      <MemberSignature Language="C#" Value="public bool IsAdjusting { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsAdjusting" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The current state of the ColorSelection</summary>
        <value>
          <see langword="true" /> if the user is currently dragging a color around, <see langword="false" /> if the selection has stopped.</value>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="OnColorChanged">
      <MemberSignature Language="C#" Value="protected virtual void OnColorChanged ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnColorChanged() cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideColorChanged", Type=typeof(Gtk.ColorSelection))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.ColorSelection.ColorChanged" /> event.</summary>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.ColorSelection.ColorChanged" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PaletteFromString">
      <MemberSignature Language="C#" Value="public static Gdk.Color[] PaletteFromString (string str);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Gdk.Color[] PaletteFromString(string str) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color[]</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="str" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="str">A palette string to parse</param>
        <summary>Parses a color palette string; the string is a colon-separated list of color names readable by <see cref="M:Gdk.ColorParse" /></summary>
        <returns>An array of <see cref="M:Gdk.Color" /> objects.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="PaletteToString">
      <MemberSignature Language="C#" Value="public static string PaletteToString (Gdk.Color[] colors);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig string PaletteToString(valuetype Gdk.Color[] colors) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="colors" Type="Gdk.Color[]" />
      </Parameters>
      <Docs>
        <param name="colors">An array of <see cref="M:Gdk.Color" /> objects. </param>
        <summary>Encodes a palette as a string; useful for persistent storage.</summary>
        <returns>A string encoding of the palette.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="PreviousAlpha">
      <MemberSignature Language="C#" Value="public ushort PreviousAlpha { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int16 PreviousAlpha" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.UInt16</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Get the alpha value of the previous color</summary>
        <value>The previous alpha value - an integer between 0 and 65535.</value>
        <remarks>
          <para>It may be confusing for a user if this property is set with no interaction from them.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PreviousColor">
      <MemberSignature Language="C#" Value="public Gdk.Color PreviousColor { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Gdk.Color PreviousColor" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>The color that was selected before the current one.</summary>
        <value>a <see cref="M:Gdk.Color" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SetPreviousRgba">
      <MemberSignature Language="C#" Value="public void SetPreviousRgba (Gdk.RGBA rgba);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPreviousRgba(valuetype Gdk.RGBA rgba) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="rgba" Type="Gdk.RGBA" />
      </Parameters>
      <Docs>
        <param name="rgba">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
  </Members>
</Type>