GtkSharp/doc/en/Gtk/HScale.xml

105 lines
4.6 KiB
XML
Raw Normal View History

<Type Name="HScale" FullName="Gtk.HScale">
<TypeSignature Language="C#" Maintainer="Lee Mallabone" Value="public class HScale : Gtk.Scale" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.6.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>A horizontal slider widget for selecting a value from a range.</summary>
<remarks>
<para>The HScale widget allows the user to select a value with a horizontal slider.</para>
<para>This widget and its model is manipulated using methods and properties in its super classes, <see cref="T:Gtk.Scale" /> and <see cref="T:Gtk.Range" />.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Scale</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HScale (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>
<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 HScale (Gtk.Adjustment adjustment);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new horizontal slider based on the data in <paramref name="adjustment" />.</summary>
<param name="adjustment">The model to use for this HScale</param>
<remarks>
<para>To create a horizontal slider without explicit use of a <see cref="T:Gtk.Adjustment" />, use the alternative constructor.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HScale (double min, double max, double step);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="min" Type="System.Double" />
<Parameter Name="max" Type="System.Double" />
<Parameter Name="step" Type="System.Double" />
</Parameters>
<Docs>
<summary>Creates a new horizontal slider without the need for an <see cref="T:Gtk.Adjustment" /> object.</summary>
<param name="min">The minimum value that is accepted by this HScale.</param>
<param name="max">The maximum value that is accepted by this HScale.</param>
<param name="step">The value to adjust the HScale by when 'sliding'.</param>
<remarks>
<para>Creates a new horizontal slider that lets the user input a number between (and including) <paramref name="min" /> and <paramref name="max" />. Each adjustment of the slider changes the value by <paramref name="step" />, which must be non-zero.</para>
</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:Gtk.HScale" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected HScale (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>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes></Member>
</Members>
</Type>