Ryujinx-GtkSharp/doc/en/Gtk/ColorSelection.xml

<Type Name="ColorSelection" FullName="Gtk.ColorSelection">
  <TypeSignature Language="C#" Value="public class ColorSelection : Gtk.VBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
  <AssemblyInfo>
    <AssemblyName>gtk-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>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>
  <Base>
    <BaseTypeName>Gtk.VBox</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="PaletteFromString">
      <MemberSignature Language="C#" Value="public static bool PaletteFromString (string str, Gdk.Color colors, int n_colors);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="str" Type="System.String" />
        <Parameter Name="colors" Type="Gdk.Color" />
        <Parameter Name="n_colors" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="str">To be added: an object of type 'string'</param>
        <param name="colors">To be added: an object of type 'Gdk.Color'</param>
        <param name="n_colors">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="PaletteToString">
      <MemberSignature Language="C#" Value="public static string PaletteToString (Gdk.Color colors, int n_colors);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="colors" Type="Gdk.Color" />
        <Parameter Name="n_colors" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="colors">To be added: an object of type 'Gdk.Color'</param>
        <param name="n_colors">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetPreviousColor">
      <MemberSignature Language="C#" Value="public void GetPreviousColor (Gdk.Color color);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="color" Type="Gdk.Color" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="color">To be added: an object of type 'Gdk.Color'</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetPreviousColor">
      <MemberSignature Language="C#" Value="public void SetPreviousColor (Gdk.Color color);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="color" Type="Gdk.Color" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="color">To be added: an object of type 'Gdk.Color'</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsAdjusting">
      <MemberSignature Language="C#" Value="public bool IsAdjusting ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the current state of the ColorSelection</summary>
        <returns>
          <see langword="true" /> if the user is currently dragging a color around, <see langword="false" /> if the selection has stopped. </returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="protected virtual 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 ColorSelection (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 ColorSelection, 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 ColorSelection ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>The main way to create a new ColorSelection</summary>
        <returns>A new ColorSelection</returns>
        <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 Gtk.ColorSelection</summary>
        <returns>The GLib Type for the Gtk.ColorSelection class.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="PreviousAlpha">
      <MemberSignature Language="C#" Value="public ushort PreviousAlpha { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.UInt16</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.UInt16" />
      </Parameters>
      <Docs>
        <summary>Get the alpha value of the previous color</summary>
        <param name="value">A new setting for the 'previous' alpha value.</param>
        <returns>The previous alpha value - an integer between 0 and 65535.</returns>
        <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="CurrentColor">
      <MemberSignature Language="C#" Value="public Gdk.Color CurrentColor { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Color</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="Gdk.Color" />
      </Parameters>
      <Docs>
        <summary>Manage the current color of the ColorSelection.</summary>
        <param name="value">A color to set as the 'current' color.</param>
        <returns>The currently selected color in this ColorSelection.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="HasPalette">
      <MemberSignature Language="C#" Value="public bool HasPalette { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Manage whether or not the ColorSelection displays a palette.</summary>
        <param name="value">
          <see langword="true" /> to display a palette in the ColorSelection, <see langword="false" /> otherwise.</param>
        <returns>
          <see langword="true" /> if a palette is currently part of the ColorSelection, <see langword="false" /> otherwise.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="HasOpacityControl">
      <MemberSignature Language="C#" Value="public bool HasOpacityControl { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Manage whether or not opacity is part of the ColorSelection.</summary>
        <param name="value">
          <see langword="true" /> to display opacity controls, <see langword="false" /> otherwise.</param>
        <returns>
          <see langword="true" /> if the user can edit opacity, <see langword="false" /> otherwise.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="CurrentAlpha">
      <MemberSignature Language="C#" Value="public ushort CurrentAlpha { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.UInt16</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.UInt16" />
      </Parameters>
      <Docs>
        <summary>Manage the current alpha value of the ColorSelection.</summary>
        <param name="value">Sets the current opacity.</param>
        <returns>The existing opacity of this ColorSelection.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ColorChanged">
      <MemberSignature Language="C#" Value="public event EventHandler ColorChanged;" />
      <MemberType>Event</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>This event is fired when the current color changes in the ColorSelection.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ColorSelection (GLib.Type gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.Type" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="gtype">GLib type for the type</param>
        <returns>Creates a new instance of ColorSelection, using the GLib-provided type</returns>
        <remarks>
          <para>This is a constructor used by derivative types of <see cref="T:Gtk.ColorSelection" /> that would have their own GLib type assigned to it.  This is not typically used by C# code.</para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>