2004-12-30 Shane Landrum <epicene@pobox.com>

* en/Gtk/Scale.xml
	* en/Gtk/Paned.xml
	* en/Gtk/ProgressBar.xml
	* en/Gtk/Plug.xml
	* en/Gtk/MovementStep.xml: Docs, some for 2.4 changes.


svn path=/trunk/gtk-sharp/; revision=38199
This commit is contained in:
Shane Landrum 2004-12-30 18:55:02 +00:00
parent 48e294a144
commit ecb6c75c26
6 changed files with 68 additions and 65 deletions

View file

@ -1,3 +1,11 @@
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/Scale.xml
* en/Gtk/Paned.xml
* en/Gtk/ProgressBar.xml
* en/Gtk/Plug.xml
* en/Gtk/MovementStep.xml: Docs, some for 2.4 changes.
2004-12-30 Shane Landrum <epicene@pobox.com>
* en/Gtk/FilesAddedArgs.xml

View file

@ -39,9 +39,6 @@
<Docs>
<summary>The cursor will move by forward/back graphemes.</summary>
<remarks>
<para>
The cursor will move by forward/back graphemes.
</para>
</remarks>
</Docs>
</Member>
@ -55,9 +52,6 @@
<Docs>
<summary>The cursor will move by left/right graphemes.</summary>
<remarks>
<para>
The cursor will move by left/right graphemes.
</para>
</remarks>
</Docs>
</Member>
@ -71,9 +65,6 @@
<Docs>
<summary>The cursor will move by forward/back words.</summary>
<remarks>
<para>
The cursor will move by forward/back words.
</para>
</remarks>
</Docs>
</Member>
@ -87,9 +78,6 @@
<Docs>
<summary>The cursor will move up/down lines (wrapped lines).</summary>
<remarks>
<para>
The cursor will move up/down lines (wrapped lines).
</para>
</remarks>
</Docs>
</Member>
@ -103,9 +91,6 @@
<Docs>
<summary>The cursor will move up/down lines (wrapped lines).</summary>
<remarks>
<para>
The cursor will move up/down lines (wrapped lines).
</para>
</remarks>
</Docs>
</Member>
@ -119,9 +104,6 @@
<Docs>
<summary>The cursor will move up/down paragraphs (newline-ended lines).</summary>
<remarks>
<para>
The cursor will move up/down paragraphs (newline-ended lines).
</para>
</remarks>
</Docs>
</Member>
@ -135,9 +117,6 @@
<Docs>
<summary>The cursor will move to either end of a paragraph.</summary>
<remarks>
<para>
The cursor will move to either end of a paragraph.
</para>
</remarks>
</Docs>
</Member>
@ -151,9 +130,6 @@
<Docs>
<summary>The cursor will move by pages.</summary>
<remarks>
<para>
The cursor will move by pages.
</para>
</remarks>
</Docs>
</Member>
@ -167,9 +143,6 @@
<Docs>
<summary>The cursor will move to the end of the buffer.</summary>
<remarks>
<para>
The cursor will move to the end of the buffer.
</para>
</remarks>
</Docs>
</Member>
@ -195,8 +168,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The cursor will move horizontally by pages.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>

View file

@ -139,11 +139,12 @@ public Widget GetExampleFrame()
<Parameter Name="child2_req" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Determines the position of the pane separator based on the
size and shrinkability of the widget's children.</summary>
<param name="allocation">A <see cref="T:System.Int32" /></param>
<param name="child1_req">A <see cref="T:System.Int32" /></param>
<param name="child2_req">A <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -222,7 +223,8 @@ public Widget GetExampleFrame()
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Whether the position property (related to <see cref="P:Gtk.Paned.MinPosition"/> and
<see cref="P:Gtk.Paned.MaxPosition"/>) should be used.</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 />
@ -452,9 +454,11 @@ public Widget GetExampleFrame()
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The largest possible value for the position property.
This property is derived from the size and shrinkability of the widget's children.
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="MinPosition">
@ -465,9 +469,11 @@ public Widget GetExampleFrame()
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The smallest possible value for the position property.
This property is derived from the size and shrinkability of the widget's children.
</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Item">

View file

@ -12,10 +12,16 @@
<Docs>
<summary>Toplevel for embedding into other processes.</summary>
<remarks>
Together with <see cref="T:Gtk.Socket" />, <see cref="T:Gtk.Plug " /> provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user.
One process creates a <see cref="T:Gtk.Socket" /> widget and, passes the ID of that widgets window to the other process, which then creates a <see cref="T:Gtk.Plug " /> with that window ID.
Any widgets contained in the <see cref="T:Gtk.Plug" /> then will appear inside the first applications window.
</remarks>
Together with <see cref="T:Gtk.Socket" />, <see
cref="T:Gtk.Plug"/> provides the ability to embed widgets from
one process into another process in a fashion that is
transparent to the user. One process creates a <see
cref="T:Gtk.Socket" /> widget and, passes the ID of that widgets
window to the other process, which then creates a <see
cref="T:Gtk.Plug " /> with that window ID. Any widgets
contained in the <see cref="T:Gtk.Plug" /> then will appear
inside the first applications window.
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Window</BaseTypeName>
@ -118,8 +124,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the plug window is reparented to the socket window.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ConstructForDisplay">
@ -133,10 +139,12 @@
<Parameter Name="socket_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Finish the initialization of the plug identified by
<paramref name="socket_id"/> which is currently displayed on <paramref name="display"/>.
</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="socket_id">a <see cref="T:System.UInt32" /></param>
<remarks>To be added</remarks>
<remarks>This method will generally only be used by derived classes.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -148,11 +156,11 @@
<Parameter Name="socket_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="socket_id">a <see cref="T:System.UInt32" /></param>
<param name="socket_id">a <see cref="T:System.UInt32" />, the ID of the socket to connect to on <paramref name="display"/>.</param>
<returns>a <see cref="T:Gtk.Plug" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -200,9 +208,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Plug" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>

View file

@ -273,9 +273,9 @@
<Parameter Name="percentage" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="percentage">a <see cref="T:System.Double" /></param>
<remarks>To be added</remarks>
<summary>Update the progress bar with a new percentage-done.</summary>
<param name="percentage">a <see cref="T:System.Double" />, the percentage completed this bar should display.</param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -286,10 +286,10 @@
<Parameter Name="adjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="adjustment">a <see cref="T:Gtk.Adjustment" /></param>
<returns>a <see cref="T:Gtk.ProgressBar" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>

View file

@ -188,9 +188,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the <see cref="T:Pango.Layout" /> used to display the scale. </summary>
<returns>a <see cref="T:Pango.Layout" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetLayoutOffsets">
@ -204,10 +204,18 @@
<Parameter Name="y" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>
Obtains the coordinates where the scale will draw the <see cref="T:Pango.Layout" />
representing the text in the scale.
</summary>
<param name="x">a <see cref="T:System.Int32" />, location to store X offset of layout</param>
<param name="y">a <see cref="T:System.Int32" />, location to store Y offset of layout </param>
<remarks>
Remember that when working with Pango you need to convert to
and from pixels using PANGO_PIXELS() or <see cref="F:Pango.Scale.PangoScale" />.
If <see cref="P:Gtk.Scale.DrawValue" /> is <see langword="false"/>, the return values are
undefined.
</remarks>
</Docs>
</Member>
</Members>