mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
Updated Ruler docs.
svn path=/trunk/gtk-sharp/; revision=12786
This commit is contained in:
Lee Mallabone
parent
73ae9d533f
commit
582723b68b
@ -1,3 +1,9 @@
|
||||
2003-03-24 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/HRuler.xml:
|
||||
* en/Gtk/VRuler.xml:
|
||||
* en/Gtk/Ruler.xml: New docs and tweaks.
|
||||
|
||||
2003-03-22 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/HRuler.xml: Short docs, simple API.
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
<Docs>
|
||||
<summary>A horizontal ruler.</summary>
|
||||
<remarks>
|
||||
<para>Rulers are used to show the location of the mouse in the window and to display the size of the window in the specified units. The available units of measurement are <see cref="P:Gtk.MetricType.Pixels"/>, <see cref="P:Gtk.MetricType.Inches"/> and <see cref="P:Gtk.MetricType.Centimeters"/>. The default is <see cref="P:Gtk.MetricType.Pixels"/>.</para>
|
||||
<para>A horizontal ruler is typically used to show the horizontal location of the mouse in the window and to display the horizontal size of the window in the specified units. The available units of measurement are <see cref="P:Gtk.MetricType.Pixels"/>, <see cref="P:Gtk.MetricType.Inches"/> and <see cref="P:Gtk.MetricType.Centimeters"/>. The default is <see cref="P:Gtk.MetricType.Pixels"/>.</para>
|
||||
<para>A horizontal ruler is typically used above or below another widget such as a <see cref="T:Gtk.DrawingArea"/>.</para>
|
||||
<para>Note:- This widget is considered too specialized for GTK+, and will likely be moved to some other package in the future.</para>
|
||||
</remarks>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="Ruler" FullName="Gtk.Ruler">
|
||||
<TypeSignature Language="C#" Value="public class Ruler : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class Ruler : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,11 @@
|
||||
</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 ruler widgets.</summary>
|
||||
<remarks><para>The Ruler widget is a base class for horizontal and vertical rulers. Rulers are used to show the mouse pointer's location in a window. Within the ruler a small triangle indicates the location of the mouse relative to the horizontal or vertical ruler. Concrete classes are <see cref="T:Gtk.HRuler"/> and <see cref="T:Gtk.VRuler"/> for horizontal and vertical rulers, respectively.</para>
|
||||
<para>With this class, you can adjust the unit type and the range of values that a ruler displays.</para>
|
||||
<para>Note:- This widget is considered too specialized for GTK+, and will likely be moved to some other package in the future.</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Widget</BaseTypeName>
|
||||
@ -66,10 +69,10 @@
|
||||
<Parameter Name="max_size" Type="System.Double" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="lower">To be added: an object of type 'double'</param>
|
||||
<param name="upper">To be added: an object of type 'double'</param>
|
||||
<param name="position">To be added: an object of type 'double'</param>
|
||||
<summary>Sets the range information.</summary>
|
||||
<param name="lower">The lower value to display on the Ruler.</param>
|
||||
<param name="upper">The upper value to display on the Ruler.</param>
|
||||
<param name="position">The current position of the mouse aligned with this Ruler.</param>
|
||||
<param name="max_size">To be added: an object of type 'double'</param>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
@ -129,9 +132,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Ruler'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -156,10 +159,10 @@
|
||||
<Parameter Name="value" Type="Gtk.MetricType" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gtk.MetricType'</param>
|
||||
<returns>To be added: an object of type 'Gtk.MetricType'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage the measurement unit that is displayed.</summary>
|
||||
<param name="value">A new unit type for the ruler.</param>
|
||||
<returns>The current units in use.</returns>
|
||||
<remarks><para>If this property is not explicitly set, the default <see cref="T:Gtk.MetricType"/> for a ruler is <see cref="P:Gtk.MetricType.Pixels"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Upper">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="VRuler" FullName="Gtk.VRuler">
|
||||
<TypeSignature Language="C#" Value="public class VRuler : Gtk.Ruler, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class VRuler : Gtk.Ruler, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
@ -7,8 +7,11 @@
|
||||
</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 vertical ruler.</summary>
|
||||
<remarks><para>This ruler is used to show the vertical location of the mouse in the window and to display the vertical size of the window in the specified units. The available units of measurement are <see cref="P:Gtk.MetricType.Pixels"/>, <see cref="P:Gtk.MetricType.Inches"/> and <see cref="P:Gtk.MetricType.Centimeters"/>. The default is <see cref="P:Gtk.MetricType.Pixels"/>.</para>
|
||||
<para>A vertical ruler is typically used along the left or right edge of another widget such as a <see cref="T:Gtk.DrawingArea"/>.</para>
|
||||
<para>Note:- This widget is considered too specialized for GTK+, and will likely be moved to some other package in the future.</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Ruler</BaseTypeName>
|
||||
@ -63,9 +66,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.VRuler'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates a new vertical Ruler.</summary>
|
||||
<returns>A new VRuler</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user