mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
First draft of Scale widget docs
svn path=/trunk/gtk-sharp/; revision=12374
This commit is contained in:
Lee Mallabone
parent
032a660b72
commit
68488b0e8e
@ -1,3 +1,8 @@
|
||||
2003-03-09 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/Scale.xml:
|
||||
* en/Gtk/[VH]Scale.xml: Simple documentation for Scale widgets.
|
||||
|
||||
2003-03-08 Miguel de Icaza <miguel@ximian.com>
|
||||
|
||||
* en/GLib/IdleHandler.xml: Documeted.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="HScale" FullName="Gtk.HScale">
|
||||
<TypeSignature Language="C#" Value="public class HScale : Gtk.Scale, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class HScale : Gtk.Scale, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,8 @@
|
||||
</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>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
@ -65,10 +65,10 @@
|
||||
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="adjustment">To be added: an object of type 'Gtk.Adjustment'</param>
|
||||
<returns>To be added: an object of type 'Gtk.HScale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
<returns>A new HScale</returns>
|
||||
<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">
|
||||
@ -81,12 +81,12 @@
|
||||
<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.HScale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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>
|
||||
<returns>A new HScale.</returns>
|
||||
<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=".ctor">
|
||||
@ -95,9 +95,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.HScale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
</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>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>A base class for the concrete slider widgets; <see cref="T:Gtk.HScale"/> and <see cref="T:Gtk.VScale"/>.</summary>
|
||||
<remarks><para>A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, <see cref="T:Gtk.Range"/>. To set the value of a scale, you would normally use the <see cref="P:Gtk.Range.Value"/> property. To detect changes to the value, connect an event handler to the <see cref="F:Gtk.Range.ValueChanged"/> event.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Range</BaseTypeName>
|
||||
@ -63,9 +63,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Scale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -90,10 +90,10 @@
|
||||
<Parameter Name="value" Type="Gtk.PositionType" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.PositionType'</param>
|
||||
<returns>To be added: an object of type 'Gtk.PositionType'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage the position of the value, relative to the slider.</summary>
|
||||
<param name="value">The position to place the value</param>
|
||||
<returns>Where the value is currently being drawn.</returns>
|
||||
<remarks><para>Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the <see cref="P:Gtk.Scale.DrawValue"/> property.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DrawValue">
|
||||
@ -106,10 +106,10 @@
|
||||
<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>
|
||||
<summary>Manage whether a label is displayed to show the current value.</summary>
|
||||
<param name="value"><see langword="true"/> to display the value, <see langword="false"/> otherwise.</param>
|
||||
<returns>Whether the value is currently being displayed.</returns>
|
||||
<remarks><para>Use the <see cref="P:Gtk.Scale.ValuePos"/> property to alter the position of displayed value.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Digits">
|
||||
@ -122,10 +122,10 @@
|
||||
<Parameter Name="value" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'int'</param>
|
||||
<returns>To be added: an object of type 'int'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage the number of decimal places for this slider.</summary>
|
||||
<param name="value">The number of decimal places to display.</param>
|
||||
<returns>The number of decimal places currently being displayed.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="FormatValue">
|
||||
@ -134,8 +134,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Allows the format of the displayed value to be altered.</summary>
|
||||
<remarks><para>Note: The signature of this event handler is currently incorrect.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="VScale" FullName="Gtk.VScale">
|
||||
<TypeSignature Language="C#" Value="public class VScale : Gtk.Scale, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class VScale : Gtk.Scale, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,9 +7,9 @@
|
||||
</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>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
</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>
|
||||
@ -65,10 +65,10 @@
|
||||
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="adjustment">To be added: an object of type 'Gtk.Adjustment'</param>
|
||||
<returns>To be added: an object of type 'Gtk.VScale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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">
|
||||
@ -81,12 +81,12 @@
|
||||
<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.VScale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<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">
|
||||
@ -95,9 +95,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.VScale'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user