Commiting documentation of ScrollType of namespace Gtk

svn path=/trunk/gtk-sharp/; revision=12289
This commit is contained in:
Hector E. Gomez Morales 2003-03-07 05:02:10 +00:00
parent efa9acf122
commit 640de1eb9f

View file

@ -1,5 +1,5 @@
<Type Name="ScrollType" FullName="Gtk.ScrollType"> <Type Name="ScrollType" FullName="Gtk.ScrollType">
<TypeSignature Language="C#" Value="public sealed struct ScrollType;" Maintainer="auto" /> <TypeSignature Language="C#" Value="public sealed struct ScrollType;" Maintainer="Hector Gomez M" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,12 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>An enumeration used by ScrolledWindow and Range.</summary>
<remarks>To be added</remarks> <remarks>
<para>
This enumeration is used by <see cref="T:Gtk.ScrolledWindow"/> and <see cref="T:Gtk.Range"/> to decide how scrolling behaves.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +38,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The default setting. Indicates that the scrollbar's slider is not moved.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The default setting. Indicates that the scrollbar's slider is not moved.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Jump"> <Member MemberName="Jump">
@ -46,8 +54,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider to the position described in the accompanying float parameter.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The range of values are 0 to 1, with the halfway point being 0.5.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StepBackward"> <Member MemberName="StepBackward">
@ -58,8 +70,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider back one step increment from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The value of the step increment is taken from the underlying <see cref="T:Gtk.GtkAdjustment"/> in the scrollbar.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StepForward"> <Member MemberName="StepForward">
@ -70,8 +86,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider forward one step increment from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The value of the step increment is taken from the underlying <see cref="T:Gtk.GtkAdjustment"/> in the scrollbar.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PageBackward"> <Member MemberName="PageBackward">
@ -82,8 +102,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider back one page increment from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The value of the step increment is taken from the underlying <see cref="T:Gtk.GtkAdjustment"/> in the scrollbar.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PageForward"> <Member MemberName="PageForward">
@ -94,8 +118,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider forward one page increment from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
The value of the step increment is taken from the underlying <see cref="T:Gtk.GtkAdjustment"/> in the scrollbar.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StepUp"> <Member MemberName="StepUp">
@ -154,8 +182,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider back one step increment to the left from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Sets the scrollbar's slider back one step increment to the left from its current position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="StepRight"> <Member MemberName="StepRight">
@ -166,8 +198,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider forward one step increment to the right from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Sets the scrollbar's slider forward one step increment to the right from its current position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PageLeft"> <Member MemberName="PageLeft">
@ -178,8 +214,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider back one page increment to the left from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Sets the scrollbar's slider back one page increment to the left from its current position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PageRight"> <Member MemberName="PageRight">
@ -190,8 +230,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider forward one page increment to the right from its current position.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Sets the scrollbar's slider forward one page increment to the right from its current position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Start"> <Member MemberName="Start">
@ -202,8 +246,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider to the beginning of the scrollbar.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Sets the scrollbar's slider to the beginning of the scrollbar.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="End"> <Member MemberName="End">
@ -214,8 +262,12 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the scrollbar's slider to the end of the scrollbar.</summary>
<remarks>To be added</remarks> <remarks>
<para>
Sets the scrollbar's slider to the end of the scrollbar.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">