GtkSharp/doc/en/Gtk/SpinButton.xml
Duncan Mak 7661dafe09 2003-02-14 Duncan Mak <duncan@ximian.com>
* en/*: Updated the docs and added a new Maintainer attribute, also
	fixed the generator to produce 'ref/out' modifiers for parameters.

svn path=/trunk/gtk-sharp/; revision=11599
2003-02-15 03:08:25 +00:00

450 lines
17 KiB
XML

<Type Name="SpinButton" FullName="Gtk.SpinButton">
<TypeSignature Language="C#" Value="public class SpinButton : Gtk.Entry, Editable, IWrapper, CellEditable, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Entry</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gtk.Editable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Gtk.CellEditable</InterfaceName>
</Interface>
<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="UpdatePolicyGetType">
<MemberSignature Language="C#" Value="public static uint UpdatePolicyGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Spin">
<MemberSignature Language="C#" Value="public void Spin (Gtk.SpinType direction, double increment);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="direction" Type="Gtk.SpinType" />
<Parameter Name="increment" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="direction">To be added: an object of type 'Gtk.SpinType'</param>
<param name="increment">To be added: an object of type 'double'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRange">
<MemberSignature Language="C#" Value="public void GetRange (out double min, out double max);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="min" Type="System.Double&amp;" />
<Parameter Name="max" Type="System.Double&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="min">To be added: an object of type 'double&amp;'</param>
<param name="max">To be added: an object of type 'double&amp;'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Configure">
<MemberSignature Language="C#" Value="public void Configure (Gtk.Adjustment adjustment, double climb_rate, uint digits);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
<Parameter Name="climb_rate" Type="System.Double" />
<Parameter Name="digits" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="adjustment">To be added: an object of type 'Gtk.Adjustment'</param>
<param name="climb_rate">To be added: an object of type 'double'</param>
<param name="digits">To be added: an object of type 'uint'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Update">
<MemberSignature Language="C#" Value="public void Update ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<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>To be added</summary>
<param name="step">To be added: an object of type 'double'</param>
<param name="page">To be added: an object of type 'double'</param>
<remarks>To be added</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>To be added</summary>
<param name="min">To be added: an object of type 'double'</param>
<param name="max">To be added: an object of type 'double'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetIncrements">
<MemberSignature Language="C#" Value="public void GetIncrements (out double step, out double page);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="step" Type="System.Double&amp;" />
<Parameter Name="page" Type="System.Double&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="step">To be added: an object of type 'double&amp;'</param>
<param name="page">To be added: an object of type 'double&amp;'</param>
<remarks>To be added</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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SpinButton (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gtk.SpinButton'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpinButton (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.SpinButton'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpinButton (Gtk.Adjustment adjustment, double climb_rate, uint digits);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
<Parameter Name="climb_rate" Type="System.Double" />
<Parameter Name="digits" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="adjustment">To be added: an object of type 'Gtk.Adjustment'</param>
<param name="climb_rate">To be added: an object of type 'double'</param>
<param name="digits">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gtk.SpinButton'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpinButton (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>To be added</summary>
<param name="min">To be added: an object of type 'double'</param>
<param name="max">To be added: an object of type 'double'</param>
<param name="step">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'Gtk.SpinButton'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SpinButton ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.SpinButton'</returns>
<remarks>To be added</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>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ValueAsInt">
<MemberSignature Language="C#" Value="public int ValueAsInt { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Numeric">
<MemberSignature Language="C#" Value="public bool Numeric { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ClimbRate">
<MemberSignature Language="C#" Value="public double ClimbRate { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Wrap">
<MemberSignature Language="C#" Value="public bool Wrap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</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>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Digits">
<MemberSignature Language="C#" Value="public uint Digits { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SnapToTicks">
<MemberSignature Language="C#" Value="public bool SnapToTicks { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UpdatePolicy">
<MemberSignature Language="C#" Value="public Gtk.SpinButtonUpdatePolicy UpdatePolicy { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.SpinButtonUpdatePolicy</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.SpinButtonUpdatePolicy" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.SpinButtonUpdatePolicy'</param>
<returns>To be added: an object of type 'Gtk.SpinButtonUpdatePolicy'</returns>
<remarks>To be added</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>
<Parameter Name="value" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Adjustment'</param>
<returns>To be added: an object of type 'Gtk.Adjustment'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Output">
<MemberSignature Language="C#" Value="public event GtkSharp.OutputHandler Output;" />
<MemberType>Event</MemberType>
<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 />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Input">
<MemberSignature Language="C#" Value="public event GtkSharp.InputHandler Input;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ChangeValue">
<MemberSignature Language="C#" Value="public event GtkSharp.ChangeValueHandler ChangeValue;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>