Ryujinx-GtkSharp/doc/en/Gtk/Range.xml
Mike Kestner 2b20e653c6 2004-06-15 Mike Kestner <mkestner@ximian.com>
* en/*/*.xml : generated summary and remarks for all the On* virtual
	default handler methods. 700 more To be addeds gone.

svn path=/trunk/gtk-sharp/; revision=29603
2004-06-15 15:41:25 +00:00

282 lines
11 KiB
XML

<Type Name="Range" FullName="Gtk.Range">
<TypeSignature Language="C#" Value="public class Range : Gtk.Widget, 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>Base class for widgets that visualize an <see cref="T:Gtk.Adjustment" />.</summary>
<remarks>
<para>This class provides helper methods and properties for manipulating concrete widgets like <see cref="T:Gtk.HScale" /> and <see cref="T:Gtk.VScale" />.</para>
</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="SetIncrements">
<MemberSignature Language="C#" Value="public void SetIncrements (double step, double page);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="step" Type="System.Double" />
<Parameter Name="page" Type="System.Double" />
</Parameters>
<Docs>
<summary>Sets the step and page sizes for this range.</summary>
<param name="step">Value difference for step movements, (see below).</param>
<param name="page">Value difference for page movements, (see below).</param>
<remarks>
<para>The <paramref name="step" /> size is used when the user clicks the <see cref="T:Gtk.Scrollbar" /> arrows or moves <see cref="T:Gtk.Scale" /> with arrow keys. The <paramref name="page" /> size is used for example when moving via Page Up or Page Down keys.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetRange">
<MemberSignature Language="C#" Value="public void SetRange (double min, double max);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="min" Type="System.Double" />
<Parameter Name="max" Type="System.Double" />
</Parameters>
<Docs>
<summary>Sets the limits of this range.</summary>
<param name="min">The minimum acceptable value for this range.</param>
<param name="max">The maximum acceptable value for this range.</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 Range (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 Range, 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="Value">
<MemberSignature Language="C#" Value="public double Value { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Manage the value of this range.</summary>
<param name="value">The new value for this range.</param>
<returns>The current value of this range.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Inverted">
<MemberSignature Language="C#" Value="public bool Inverted { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Manage whether the control of this range is manipulated in the opposite direction.</summary>
<param name="value">Set to <see langword="true" /> to invert the controls.</param>
<returns>Whether visual control of the range is currently inverted.</returns>
<remarks>
<para>Setting this to <see langword="true" /> causes a <see cref="T:Gtk.VScale" /> widget to move from right to left, instead of left to right.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="UpdatePolicy">
<MemberSignature Language="C#" Value="public Gtk.UpdateType UpdatePolicy { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.UpdateType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Manage how often the value label is updated.</summary>
<param name="value">A new update policy.</param>
<returns>The current update policy.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Adjustment">
<MemberSignature Language="C#" Value="public Gtk.Adjustment Adjustment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Adjustment</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Manipulate the underlying model of this range.</summary>
<param name="value">Sets a new <see cref="T:Gtk.Adjustment" /> object to model this range.</param>
<returns>The current <see cref="T:Gtk.Adjustment" /> underlying this range.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MoveSlider">
<MemberSignature Language="C#" Value="public event Gtk.MoveSliderHandler MoveSlider;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.MoveSliderHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ValueChanged">
<MemberSignature Language="C#" Value="public event EventHandler ValueChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Fired when the value in this range changes.</summary>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" /> to find out when the value changes.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AdjustBounds">
<MemberSignature Language="C#" Value="public event Gtk.AdjustBoundsHandler AdjustBounds;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.AdjustBoundsHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</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>To be added</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="OnAdjustBounds">
<MemberSignature Language="C#" Value="protected virtual void OnAdjustBounds (double new_value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_value" Type="System.Double" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Range.AdjustBounds" /> event.</summary>
<param name="new_value">a <see cref="T:System.Double" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Range.AdjustBounds" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnValueChanged">
<MemberSignature Language="C#" Value="protected virtual void OnValueChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Range.ValueChanged" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Range.ValueChanged" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnMoveSlider">
<MemberSignature Language="C#" Value="protected virtual void OnMoveSlider (Gtk.ScrollType scroll);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scroll" Type="Gtk.ScrollType" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Range.MoveSlider" /> event.</summary>
<param name="scroll">a <see cref="T:Gtk.ScrollType" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Range.MoveSlider" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Range (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.Range" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Range ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.Range" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>