mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-27 20:35:36 +00:00
249 lines
10 KiB
XML
249 lines
10 KiB
XML
<Type Name="Ruler" FullName="Gtk.Ruler">
|
|
<TypeSignature Language="C#" Value="public class Ruler : 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>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>
|
|
</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="DrawTicks">
|
|
<MemberSignature Language="C#" Value="public void DrawTicks ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Draws tickmarks on the ruler.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DrawPos">
|
|
<MemberSignature Language="C#" Value="public void DrawPos ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Draws the mouse position mark on the ruler.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetRange">
|
|
<MemberSignature Language="C#" Value="public void SetRange (double lower, double upper, double position, double max_size);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="lower" Type="System.Double" />
|
|
<Parameter Name="upper" Type="System.Double" />
|
|
<Parameter Name="position" Type="System.Double" />
|
|
<Parameter Name="max_size" Type="System.Double" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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">A <see cref="T:System.Double" />, the maximum size of the ruler.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetRange">
|
|
<MemberSignature Language="C#" Value="public void GetRange (out double lower, out double upper, out double position, out double max_size);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="lower" Type="System.Double&" RefType="out" />
|
|
<Parameter Name="upper" Type="System.Double&" RefType="out" />
|
|
<Parameter Name="position" Type="System.Double&" RefType="out" />
|
|
<Parameter Name="max_size" Type="System.Double&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets the range information.</summary>
|
|
<param name="lower">A <see cref="T:System.Double" /> for the lower value to display on the Ruler.</param>
|
|
<param name="upper">A <see cref="T:System.Double" /> for the upper value to display on the Ruler.</param>
|
|
<param name="position">A <see cref="T:System.Double" /> for the current position of the mouse aligned with this Ruler.</param>
|
|
<param name="max_size">A <see cref="T:System.Double" />, the maximum size of the ruler.</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 Ruler (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 Ruler, 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="Metric">
|
|
<MemberSignature Language="C#" Value="public Gtk.MetricType Metric { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.MetricType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<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">
|
|
<MemberSignature Language="C#" Value="public double Upper { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The upper value to display on the ruler.</summary>
|
|
<param name="value">A <see cref="T:System.Double" /></param>
|
|
<returns>A <see cref="T:System.Double" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Position">
|
|
<MemberSignature Language="C#" Value="public double Position { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The position of the mouse mark on the ruler.</summary>
|
|
<param name="value">A <see cref="T:System.Double" /></param>
|
|
<returns>A <see cref="T:System.Double" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxSize">
|
|
<MemberSignature Language="C#" Value="public double MaxSize { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The maximum size of the ruler.</summary>
|
|
<param name="value">A <see cref="T:System.Double" /></param>
|
|
<returns>A <see cref="T:System.Double" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Lower">
|
|
<MemberSignature Language="C#" Value="public double Lower { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The lower limit of the ruler.</summary>
|
|
<param name="value">A <see cref="T:System.Double" /></param>
|
|
<returns>A <see cref="T:System.Double" /></returns>
|
|
<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>GType Property.</summary>
|
|
<returns>a <see cref="T:GLib.GType" /></returns>
|
|
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.Ruler" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Ruler (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Protected Constructor.</summary>
|
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
|
<returns>a <see cref="T:Gtk.Ruler" /></returns>
|
|
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Ruler ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Protected constructor.</summary>
|
|
<returns>a <see cref="T:Gtk.Ruler" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |