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

2004-09-06 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/Adjustment.xml
	* en/Gtk/Callback.xml
	* en/Gtk/Clipboard.xml
	* en/Gtk/Quit.xml
	* en/Gtk/ReadyEvent.xml
	* en/Gtk/ImageStockData.xml
	* en/Gtk/MovementStep.xml
	* en/Gtk/RulerMetric.xml
	* en/Gtk/Selection.xml
	* en/Gtk/ThreadNotify.xml: Docs for assorted helper classes.

svn path=/trunk/gtk-sharp/; revision=33413
This commit is contained in:
Shane Landrum 2004-09-06 14:51:09 +00:00
parent 4ed3adf7a2
commit 5a116de32a
11 changed files with 81 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/ChangeLog
View file

@ -1,3 +1,16 @@
2004-09-06 Shane Landrum <epicene@pobox.com>
* en/Gtk/Adjustment.xml
* en/Gtk/Callback.xml
* en/Gtk/Clipboard.xml
* en/Gtk/Quit.xml
* en/Gtk/ReadyEvent.xml
* en/Gtk/ImageStockData.xml
* en/Gtk/MovementStep.xml
* en/Gtk/RulerMetric.xml
* en/Gtk/Selection.xml
* en/Gtk/ThreadNotify.xml: Docs for assorted helper classes.
2004-09-06 Shane Landrum <epicene@pobox.com> 2004-09-06 Shane Landrum <epicene@pobox.com>
* en/Gtk/ProgressBar.xml * en/Gtk/ProgressBar.xml

6
doc/en/Gtk/Adjustment.xml
View file

@ -339,10 +339,10 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default constructor.</summary>
<returns>a <see cref="T:Gtk.Adjustment" /></returns> <returns>a <see cref="T:Gtk.Adjustment" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/Callback.xml
View file

@ -7,8 +7,8 @@
</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>A delegate that can be run over a series of widgets.</summary>
<remarks>To be added</remarks> <remarks>Invoked by <see cref="M:Gtk.Container.Forall"/>.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
</Type> </Type>

18
doc/en/Gtk/Clipboard.xml
View file

@ -261,10 +261,12 @@
<Parameter Name="cb" Type="Gtk.ClipboardReceivedFunc" /> <Parameter Name="cb" Type="Gtk.ClipboardReceivedFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Requests the contents of clipboard as the given target.
<param name="target">a <see cref="T:Gdk.Atom" /></param> When the results of the result are later received the supplied
<param name="cb">a <see cref="T:Gtk.ClipboardReceivedFunc" /></param> callback will be called.</summary>
<remarks>To be added</remarks> <param name="target">a <see cref="T:Gdk.Atom" /> representing the form into which the clipboard-owning program should convert the selection.</param>
<param name="cb">a <see cref="T:Gtk.ClipboardReceivedFunc" />, a function to call when the clipboard results are received.</param>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RequestText"> <Member MemberName="RequestText">
@ -277,9 +279,9 @@
<Parameter Name="cb" Type="Gtk.ClipboardTextReceivedFunc" /> <Parameter Name="cb" Type="Gtk.ClipboardTextReceivedFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Fetch the clipboard's text and fire the function <paramref name="cb"/> on it.</summary>
<param name="cb">a <see cref="T:Gtk.ClipboardTextReceivedFunc" /></param> <param name="cb">a <see cref="T:Gtk.ClipboardTextReceivedFunc" /></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -302,9 +304,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Proctected constructor.</summary>
<returns>a <see cref="T:Gtk.Clipboard" /></returns> <returns>a <see cref="T:Gtk.Clipboard" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

6
doc/en/Gtk/ImageStockData.xml
View file

@ -56,9 +56,9 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>An identifier for this stock image.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

10
doc/en/Gtk/MovementStep.xml
View file

@ -10,12 +10,8 @@
</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>An enumeration used by Label.</summary> <summary>An enumeration used by <see cref="T:Gtk.Label" /> to decide how the cursor will move.</summary>
<remarks> <remarks/>
<para>
This enumeration is used by <see cref="T:Gtk.Label" /> to decide how the cursor will move.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -191,4 +187,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

2
doc/en/Gtk/Quit.xml
View file

@ -10,7 +10,7 @@
</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>Object to encapsulate code for running at the end of program execution.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>

6
doc/en/Gtk/ReadyEvent.xml
View file

@ -9,8 +9,8 @@
</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>Delegate specifying a signature for functions that run whenever <see cref="M:Gtk.ThreadNotify.WakeupMain ()" /> is invoked.</summary>
<remarks>To be added</remarks> <remarks>See <see cref="T:Gtk.ThreadNotify"/>.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
</Type> </Type>

20
doc/en/Gtk/RulerMetric.xml
View file

@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default constructor.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A <see cref="T:IntPtr"/>, pointer to the underlying C object.</param>
<returns>To be added: an object of type 'Gtk.RulerMetric'</returns> <returns>A <see cref="T:Gtk.RulerMetric"/></returns>
<remarks/> <remarks>For internal use only.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MetricName"> <Member MemberName="MetricName">
@ -56,7 +56,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The name of the units this ruler measures: one of Pixels, Inches, or Centimeters.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -69,8 +69,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The abbreviations for this metric's units: "Pi" for pixels, "In" for inches, "Cn" for centimeters.</summary>
<remarks/> <remarks>"Cn" isn't a typo; that's how it's defined in Gtk+. See bugzilla.gnome.org bug 151944.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PixelsPerUnit"> <Member MemberName="PixelsPerUnit">
@ -82,7 +82,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The conversion factor between pixels and the given unit for the ruler.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -95,7 +95,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>An array of possible scales for the ruler, dependent on the units chosen.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -108,7 +108,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>How many sub-units to break up each ruler unit into.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>

58
doc/en/Gtk/Selection.xml
View file

@ -51,9 +51,9 @@
<Parameter Name="selection" Type="Gdk.Atom" /> <Parameter Name="selection" Type="Gdk.Atom" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Remove all targets registered for the given selection for the widget.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="selection">a <see cref="T:Gdk.Atom" /></param> <param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection.</param>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -67,7 +67,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Removes all handlers and unsets ownership of all
selections for a widget. Called when widget is being
destroyed.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">a <see cref="T:Gtk.Widget" /></param>
<remarks/> <remarks/>
</Docs> </Docs>
@ -83,11 +85,11 @@
<Parameter Name="evnt" Type="Gdk.EventSelection" /> <Parameter Name="evnt" Type="Gdk.EventSelection" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The default handler for the <see cref="E:Gtk.Widget.SelectionClearEvent"/> event. Instead of calling this function, chain up from your <see cref="Gtk.SelectionClearEventHandler"/>. Calling this function from any other context is illegal.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="evnt">a <see cref="T:Gdk.EventSelection" /></param> <param name="evnt">a <see cref="T:Gdk.EventSelection" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, true if the event was handled, otherwise false</returns>
<remarks/> <remarks>This function will be deprecated in future versions of GTK+ and GTK#.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Convert"> <Member MemberName="Convert">
@ -103,12 +105,14 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Request the contents of a selection. When received,
<param name="widget">a <see cref="T:Gtk.Widget" /></param> a <see cref="E:Gtk.Widget.SelectionReceived"/> event will
<param name="selection">a <see cref="T:Gdk.Atom" /></param> be generated. </summary>
<param name="target">a <see cref="T:Gdk.Atom" /></param> <param name="widget">a <see cref="T:Gtk.Widget" />, the requesting widget</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="selection">a <see cref="T:Gdk.Atom" />, the selection to get</param>
<returns>a <see cref="T:System.Boolean" /></returns> <param name="target">a <see cref="T:Gdk.Atom" />, the form of the information ("STRING" for example) (TODO: elaborate possible options)</param>
<param name="time_">a <see cref="T:System.UInt32" />, the time the request is being made</param>
<returns>a <see cref="T:System.Boolean" />, true if the request succeeded, false if it couldn't be processed.</returns>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -125,12 +129,12 @@
<Parameter Name="info" Type="System.UInt32" /> <Parameter Name="info" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Add the specified target to the list of supported targets for this selection.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">a <see cref="T:Gtk.Widget" />, the widget for which this target applies</param>
<param name="selection">a <see cref="T:Gdk.Atom" /></param> <param name="selection">a <see cref="T:Gdk.Atom" />, the selection data</param>
<param name="target">a <see cref="T:Gdk.Atom" /></param> <param name="target">a <see cref="T:Gdk.Atom" /></param>
<param name="info">a <see cref="T:System.UInt32" /></param> <param name="info">a <see cref="T:System.UInt32" /></param>
<remarks/> <remarks>TODO: this could be better-explained.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OwnerSet"> <Member MemberName="OwnerSet">
@ -145,11 +149,11 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Claims ownership of a given selection for a particular widget, or if <paramref name="widget"/> is <see langword="null"/>, release ownership of the selection.</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">a <see cref="T:Gtk.Widget" /> or <see langword="null"/></param>
<param name="selection">a <see cref="T:Gdk.Atom" /></param> <param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection to claim.</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="time_">a <see cref="T:System.UInt32" />, a timestamp to use in claiming the selection.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, true if the operation succeeded.</returns>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -166,12 +170,12 @@
<Parameter Name="time_" Type="System.UInt32" /> <Parameter Name="time_" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Claims ownership of a given selection on a given display for a particular widget, or if <paramref name="widget"/> is <see langword="null"/>, release ownership of the selection.</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param> <param name="display">a <see cref="T:Gdk.Display" />, the display where the selection is set.</param>
<param name="widget">a <see cref="T:Gtk.Widget" /></param> <param name="widget">a <see cref="T:Gtk.Widget" /> or <see langword="null"/></param>
<param name="selection">a <see cref="T:Gdk.Atom" /></param> <param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection to claim.</param>
<param name="time_">a <see cref="T:System.UInt32" /></param> <param name="time_">a <see cref="T:System.UInt32" />, a timestamp to use in claiming the selection.</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, true if the operation succeeded.</returns>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>

2
doc/en/Gtk/ThreadNotify.xml
View file

@ -121,4 +121,4 @@ class Demo {
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>