mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-08 07:53:17 +02:00
First draft of Adjustment docs.
svn path=/trunk/gtk-sharp/; revision=12734
This commit is contained in:
Lee Mallabone
parent
b0b6e31e78
commit
f8c625b0f9
@ -1,5 +1,7 @@
|
||||
2003-03-21 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/Adjustment.xml: First draft; good docs for ClampPage missing.
|
||||
|
||||
* en/Gtk/CalendarDisplayOptions.xml:
|
||||
* en/Gtk/AnchorType.xml: Simple docs for these enums.
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<Type Name="Adjustment" FullName="Gtk.Adjustment">
|
||||
<TypeSignature Language="C#" Value="public class Adjustment : Gtk.Object, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class Adjustment : Gtk.Object, 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>Encapsulates an adjustable bounded value.</summary>
|
||||
<remarks><para>The Adjustment object represents a value with an associated <see cref="P:Gtk.Adjustment.Lower"/> and <see cref="P:Gtk.Adjustment.Upper"/> bound, together with a <see cref="P:Gtk.Adjustment.StepIncrement"/>, <see cref="P:Gtk.Adjustment.PageIncrement"/>, and a <see cref="P:Gtk.Adjustment.PageSize"/>.</para>
|
||||
<para>The Adjustment object does not update the value itself. Instead it is left up to the owner of the Adjustment to control the value. The owner of the Adjustment typically calls the <see cref="M:Gtk.Adjustment.ValueChanged"/> and <see cref="M:Gtk.Adjustment.Changed"/> methods after changing the value or its bounds, respectively. This results in the emission of the <see cref="F:Gtk.Adjustment.ValueChanged"/> or <see cref="F:Gtk.Adjustment.Changed"/> events respectively.</para>
|
||||
<para>An Adjustment is used within several widgets, including <see cref="T:Gtk.SpinButton"/>, <see cref="T:Gtk.Viewport"/>, and <see cref="T:Gtk.Range"/> (which is a base class for <see cref="T:Gtk.HScrollbar"/>, <see cref="T:Gtk.VScrollbar"/>, <see cref="T:Gtk.HScale"/>, and <see cref="T:Gtk.VScale"/>).</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Object</BaseTypeName>
|
||||
@ -37,13 +40,13 @@
|
||||
<Parameter Name="page_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="step_increment">To be added: an object of type 'double'</param>
|
||||
<param name="page_increment">To be added: an object of type 'double'</param>
|
||||
<param name="page_size">To be added: an object of type 'double'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Sets all the properties of the Adjustment at the same time.</summary>
|
||||
<param name="lower">The minimum value.</param>
|
||||
<param name="upper">The maximum value.</param>
|
||||
<param name="step_increment">The increment to use to make minor changes to the value.</param>
|
||||
<param name="page_increment">The increment to use to make major changes to the value.</param>
|
||||
<param name="page_size">The page size. In a <see cref="T:Gtk.Scrollbar"/> this is the size of the area that is currently visible.</param>
|
||||
<remarks><para>When updating the values and properties of an Adjustment, remember to call the <see cref="M:Gtk.Adjustment.Changed"/> and/or <see cref="M:Gtk.Adjustment.ValueChanged"/> methods to ensure the correct events are fired.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ChangeValue">
|
||||
@ -54,8 +57,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Fires the <see cref="F:Gtk.Adjustment.ValueChanged"/> event.</summary>
|
||||
<remarks><para>This method should be called manually after changing properties to notify all listening objects that the Adjustment's <see cref="P:Gtk.Adjustment.Value"/> has changed.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Change">
|
||||
@ -66,8 +69,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Fires the <see cref="F:Gtk.Adjustment.Changed"/> event.</summary>
|
||||
<remarks><para>This method should be called manually after changing properties to notify all listening objects that one or more of the Adjustment's bounds have changed.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ClampPage">
|
||||
@ -81,10 +84,10 @@
|
||||
<Parameter Name="upper" Type="System.Double" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Updates the <see cref="P:Gtk.Adjustment.Value"/> to ensure that the range between lower and upper is in the current page (i.e. between value and value + page_size).</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>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks><para>To be added: The docs for this function are very confusing, and not 100% in sync with the code of gtk+ 2.0.5.</para><para>If the range is larger than the page size, then only the start of it will be in the current page. The <see cref="F:Gtk.Adjustment.ValueChanged"/> event will be fired if the value changes as a result of this method.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -128,15 +131,15 @@
|
||||
<Parameter Name="page_size" Type="System.Double" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'double'</param>
|
||||
<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="step_increment">To be added: an object of type 'double'</param>
|
||||
<param name="page_increment">To be added: an object of type 'double'</param>
|
||||
<param name="page_size">To be added: an object of type 'double'</param>
|
||||
<returns>To be added: an object of type 'Gtk.Adjustment'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates an Adjustment with the specified value and bounds.</summary>
|
||||
<param name="value">The initial value.</param>
|
||||
<param name="lower">The minimum value.</param>
|
||||
<param name="upper">The maximum value.</param>
|
||||
<param name="step_increment">The increment to use to make minor changes to the value.</param>
|
||||
<param name="page_increment">The increment to use to make major changes to the value.</param>
|
||||
<param name="page_size">The page size. In a <see cref="T:Gtk.Scrollbar"/> this is the size of the area that is currently visible.</param>
|
||||
<returns>A new Adjustment</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
@ -145,9 +148,9 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Adjustment'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Internal constructor</summary>
|
||||
<returns></returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
@ -172,10 +175,10 @@
|
||||
<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>
|
||||
<summary>Manage the size of a 'page'.</summary>
|
||||
<param name="value">The new page size.</param>
|
||||
<returns>The current size of pages in this Adjustment.</returns>
|
||||
<remarks><para>In a <see cref="T:Gtk.Scrollbar"/> this is the size of the area which is currently visible.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="PageIncrement">
|
||||
@ -188,10 +191,10 @@
|
||||
<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>
|
||||
<summary>Manage the increment used to make major changes to the value.</summary>
|
||||
<param name="value">A new value for the PageIncrement</param>
|
||||
<returns>The current PageIncrement.</returns>
|
||||
<remarks><para>The usefulness of this value is entirely dependent upon the context in whic hthe Adjustment is used.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="StepIncrement">
|
||||
@ -201,9 +204,9 @@
|
||||
<ReturnType>System.Double</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'double'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The increment to use to make minor changes to the value.</summary>
|
||||
<returns>The current value used for step increments.</returns>
|
||||
<remarks><para>In a <see cref="T:Gtk.Scrollbar"/> this increment is used when the mouse is clicked on the arrows at the top and bottom of the <see cref="T:Gtk.Scrollbar"/>, to scroll by a small amount.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Upper">
|
||||
@ -213,9 +216,9 @@
|
||||
<ReturnType>System.Double</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'double'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Retrieve the upper bound of this Adjustment.</summary>
|
||||
<returns>The maximum possible value that is currently allowed.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Lower">
|
||||
@ -225,9 +228,9 @@
|
||||
<ReturnType>System.Double</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'double'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Retrieve the lower bound of this Adjustment.</summary>
|
||||
<returns>The minimum possible value that is currently allowed.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Value">
|
||||
@ -240,10 +243,10 @@
|
||||
<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>
|
||||
<summary>Manage the current <paramref name="value"/>.</summary>
|
||||
<param name="value">A new value for this Adjustment.</param>
|
||||
<returns>The current value of this adjustment.</returns>
|
||||
<remarks><para>If you set this property, you should manually call <see cref="M:Gtk.Adjustment.ChangeValue"/> so that all listening objects are notified of the change.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ValueChanged">
|
||||
@ -252,8 +255,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>This event is fired when <see cref="M:Gtk.Adjustment.ChangeValue"/> is called.</summary>
|
||||
<remarks><para>This event can be handled to be notified of changes to the Adjustment's value. However, this relies on all objects that change the <see cref="P:Gtk.Adjustment.Value"/> calling <see cref="M:Gtk.Adjustment.ChangeValue"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Changed">
|
||||
@ -262,8 +265,8 @@
|
||||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>This event is fired when <see cref="M:Gtk.Adjustment.Change"/> is called.</summary>
|
||||
<remarks><para>If the Adjustment's properties change, (such as <see cref="P:Gtk.Adjustment.Upper"/>, <see cref="P:Gtk.Adjustment.Lower"/> etc.), it is up to whichever class changes the values to call <see cref="M:Gtk.Adjustment.Change"/> to ensure this event is fired.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user