ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add first drafts, without examples.

Browse source 
svn path=/trunk/gtk-sharp/; revision=14588
This commit is contained in:
John Luke 2003-05-15 00:47:59 +00:00
parent ddc14873b2
commit 15d2a0c710
3 changed files with 86 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ChangeLog
View file

@ -1,3 +1,7 @@
2003-05-14 John Luke <jluke@cfl.rr.com>
* en/Gtk/Progress.xml:
* en/Gtk/ProgressBar.xml: Add first drafts, without examples.
2003-05-09 John Luke <jluke@cfl.rr.com>
* en/Gtk/ToolTips.xml: Add first draft, example.

37
doc/en/Gtk/Progress.xml
View file

@ -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>The base class for <see cref="T:Gtk.ProgressBar"/>.</summary>
<remarks>A <see cref="T:Gtk.Progress"/> is the abstract base class used to derive a <see cref="T:Gtk.ProgressBar"/>which provides a visual representation of the progress of a long running operation.</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -64,7 +64,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Progress'</returns>
<returns>an object of type <see cref="T:Gtk.Progress"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -75,8 +75,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.Progress</summary>
<returns>The GLib Type for the Gtk.Progress class.</returns>
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.Progress"/></summary>
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.Progress"/> class.</returns>
<remarks />
</Docs>
</Member>
@ -90,10 +90,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>Controls whether progress text is shown.</summary>
<param name="value">an object of type <see cref="T:System.Boolean"/></param>
<returns>an object of type <see cref="T:System.Boolean"/></returns>
<remarks>Controls whether progress text is shown.</remarks>
</Docs>
</Member>
<Member MemberName="ActivityMode">
@ -106,10 +106,11 @@
<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>The mode of the <see cref="T:Gtk.Progress"/> object.</summary>
<param name="value">an object of type <see cref="T:System.Boolean"/></param>
<returns>an object of type <see cref="T:System.Boolean"/></returns>
<remarks>A <see cref="T:Gtk.Progress"/> can be in one of two different modes: percentage mode (the default) and activity mode.
In activity mode, the progress is simply indicated as activity rather than as a percentage complete.</remarks>
</Docs>
</Member>
<Member MemberName="TextYalign">
@ -123,8 +124,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'float'</param>
<returns>To be added: an object of type 'float'</returns>
<param name="value">an object of type 'float'</param>
<returns>an object of type 'float'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -139,8 +140,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'float'</param>
<returns>To be added: an object of type 'float'</returns>
<param name="value">an object of type 'float'</param>
<returns>an object of type 'float'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -161,4 +162,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

108
doc/en/Gtk/ProgressBar.xml
View file

@ -7,8 +7,19 @@
</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 widget which indicates progress visually.</summary>
<remarks>
<para>The <see cref="T:Gtk.ProgressBar"/> is typically used to display the progress of a long running operation.
It provides a visual clue that processing is underway.
The <see cref="T:Gtk.ProgressBar"/> can be used in two different modes: percentage mode and activity mode.</para>
<para>When an application can determine how much work needs to take place (e.g. read a fixed number of bytes from a file) and can monitor its progress,
it can use the <see cref="T:Gtk.ProgressBar"/> in percentage mode and the user sees a growing bar indicating the percentage of the work that has been completed.
In this mode, the application is required to set <see cref="P:Gtk.ProgressBar.Fraction"/> periodically to update the progress bar.</para>
<para>When an application has no accurate way of knowing the amount of work to do, it can use the <see cref="T:Gtk.ProgressBar"/> in activity mode, which shows activity by a block moving back and forth within the progress area.
In this mode, the application is required to call <see cref="M:Gtk.ProgressBar.Pulse()"/> perodically to update the progress bar.</para>
<para>There is quite a bit of flexibility provided to control the appearance of the <see cref="T:Gtk.ProgressBar"/>.
Functions are provided to control the orientation of the bar, optional text can be displayed along with the bar, and the step size used in activity mode can be set.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Progress</BaseTypeName>
@ -37,8 +48,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Indicates an unknown amount of progress has been made</summary>
<remarks>Indicates that some progress has been made, but you don't know how much.
This causes the <see cref="T:Gtk.ProgressBar"/> to enter "activity mode," where a block bounces back and forth.
Each call to <see cref="M:Gtk.ProgressBar.Pulse()"/> causes the block to move by a little bit (the amount of movement per pulse is determined by <see cref="P:Gtk.ProgressBar.PulseStep"/>).</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -75,9 +88,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ProgressBar'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gtk.ProgressBar"/>.</summary>
<returns>an object of type <see cref="T:Gtk.ProgressBar"/></returns>
<remarks>Creates a new <see cref="T:Gtk.ProgressBar"/>.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -87,8 +100,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.ProgressBar</summary>
<returns>The GLib Type for the Gtk.ProgressBar class.</returns>
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.ProgressBar"/></summary>
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.ProgressBar"/> class.</returns>
<remarks />
</Docs>
</Member>
@ -103,8 +116,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Adjustment'</param>
<returns>To be added: an object of type 'Gtk.Adjustment'</returns>
<param name="value">an object of type <see cref="T:Gtk.Adjustment"/></param>
<returns>an object of type <see cref="T:Gtk.Adjustment"/></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -118,10 +131,10 @@
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>The number of blocks that the <see cref="T:Gtk.ProgressBar"/> is divided into.</summary>
<param name="value">an object of type <see cref="T:System.UInt32"/></param>
<returns>an object of type <see cref="T:System.UInt32"/></returns>
<remarks>The number of blocks that the <see cref="T:Gtk.ProgressBar"/> is divided into when the style is discrete.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
@ -134,10 +147,11 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The text displayed superimposed on the <see cref="T:Gtk.ProgressBar"/>.</summary>
<param name="value">an object of type <see cref="T:System.String"/></param>
<returns>an object of type <see cref="T:System.String"/></returns>
<remarks>The text displayed superimposed on the <see cref="T:Gtk.ProgressBar"/>, if any, otherwise <see langword="null"/>.
The return value is a reference to the text, not a copy of it, so will become invalid if you change the text in the <see cref="T:Gtk.ProgressBar"/>.</remarks>
</Docs>
</Member>
<Member MemberName="Orientation">
@ -150,10 +164,10 @@
<Parameter Name="value" Type="Gtk.ProgressBarOrientation" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.ProgressBarOrientation'</param>
<returns>To be added: an object of type 'Gtk.ProgressBarOrientation'</returns>
<remarks>To be added</remarks>
<summary>The current <see cref="T:Gtk.ProgressBar"/> orientation.</summary>
<param name="value">an object of type <see cref="T:Gtk.ProgressBarOrientation"/></param>
<returns>an object of type <see cref="T:Gtk.ProgressBarOrientation"/></returns>
<remarks>The current <see cref="T:Gtk.ProgressBar"/> orientation.</remarks>
</Docs>
</Member>
<Member MemberName="ActivityStep">
@ -166,10 +180,11 @@
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>The step value used when the <see cref="T:Gtk.ProgressBar"/> is in activity mode.</summary>
<param name="value">an object of type <see cref="T:System.UInt32"/></param>
<returns>an object of type <see cref="T:System.UInt32"/></returns>
<remarks>The step value used when the <see cref="T:Gtk.ProgressBar"/> is in activity mode.
The step is the amount by which the progress is incremented each iteration.</remarks>
</Docs>
</Member>
<Member MemberName="Fraction">
@ -182,10 +197,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>The current fraction of the task that has been completed.</summary>
<param name="value">an object of type <see cref="T:System.Double"/></param>
<returns>an object of type <see cref="T:System.Double"/></returns>
<remarks>The current fraction of the task that has been completed.</remarks>
</Docs>
</Member>
<Member MemberName="ActivityBlocks">
@ -198,10 +213,11 @@
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>The number of blocks used when the <see cref="T:Gtk.ProgressBar"/> is in activity mode.</summary>
<param name="value">an object of type <see cref="T:System.UInt32"/></param>
<returns>an object of type <see cref="T:System.UInt32"/></returns>
<remarks>The number of blocks used when the <see cref="T:Gtk.ProgressBar"/> is in activity mode.
Larger numbers make the visible block smaller.</remarks>
</Docs>
</Member>
<Member MemberName="BarStyle">
@ -214,10 +230,12 @@
<Parameter Name="value" Type="Gtk.ProgressBarStyle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.ProgressBarStyle'</param>
<returns>To be added: an object of type 'Gtk.ProgressBarStyle'</returns>
<remarks>To be added</remarks>
<summary>The style for drawing the <see cref="T:Gtk.ProgressBar"/>.</summary>
<param name="value">an object of type <see cref="T:Gtk.ProgressBarStyle"/></param>
<returns>an object of type <see cref="T:Gtk.ProgressBarStyle"/></returns>
<remarks>The style for drawing the <see cref="T:Gtk.ProgressBar"/>.
Continuous - The <see cref="T:Gtk.ProgressBar"/> grows in a smooth, continuous manner.
Discrete - The <see cref="T:Gtk.ProgressBar"/> grows in discrete, visible blocks.</remarks>
</Docs>
</Member>
<Member MemberName="PulseStep">
@ -230,10 +248,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>The fraction of total <see cref="T:Gtk.ProgressBar"/> length to move the bouncing block for each call to <see cref="M:Gtk.ProgressBar.Pulse()"/>.</summary>
<param name="value">an object of type <see cref="T:System.Double"/></param>
<returns>an object of type <see cref="T:System.Double"/></returns>
<remarks>The fraction of total <see cref="T:Gtk.ProgressBar"/> length to move the bouncing block for each call to <see cref="M:Gtk.ProgressBar.Pulse()"/>.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -246,11 +264,11 @@
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of ProgressBar, using the GLib-provided type</returns>
<returns>Creates a new instance of <see cref="T:Gtk.ProgressBar"/>, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.ProgressBar" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>