GtkSharp/doc/en/Gtk/VScale.xml

141 lines
5.8 KiB
XML
Raw Normal View History

<Type Name="VScale" FullName="Gtk.VScale">
<TypeSignature Language="C#" Value="public class VScale : Gtk.Scale, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<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 vertical slider widget for selecting a value from a range.</summary>
<remarks>
<para>The VScale widget allows the user to select a value with a vertical 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>
<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="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 VScale (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 VScale, 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 VScale (Gtk.Adjustment adjustment);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new vertical slider based on the data in <paramref name="adjustment" />.</summary>
<param name="adjustment">The model to use for this VScale</param>
<returns>A new VScale</returns>
<remarks>
<para>To create a vertical 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 VScale (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 vertical slider without the need for an <see cref="T:Gtk.Adjustment" /> object.</summary>
<param name="min">The minimum value that is accepted by this VScale.</param>
<param name="max">The maximum value that is accepted by this VScale.</param>
<param name="step">The value to adjust the VScale by when 'sliding'.</param>
<returns>A new VScale.</returns>
<remarks>
<para>Creates a new vertical 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=".ctor">
<MemberSignature Language="C#" Value="protected VScale ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<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.VScale</summary>
<returns>The GLib Type for the Gtk.VScale class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected VScale (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 VScale, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.VScale" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>