2005-01-02 Shane Landrum <epicene@pobox.com>

* en/Gtk/ComboBox.xml: Doc edits.
	* en/Gtk/ContainerChild.xml
	* en/Gtk/Drag.xml
	* en/Gtk/Draw.xml
	* en/Gtk/CellViewMenuItem.xml
	* en/Gtk/DisconnectProxyArgs.xml
	* en/Gtk/CellView.xml
	* en/Gtk/Container.xml: added docs.


svn path=/trunk/gtk-sharp/; revision=38259
This commit is contained in:
Shane Landrum 2005-01-03 03:28:16 +00:00
parent 1196cf6732
commit 0df8781e8b
9 changed files with 113 additions and 65 deletions

View File

@ -1,3 +1,14 @@
2005-01-02 Shane Landrum <epicene@pobox.com>
* en/Gtk/ComboBox.xml: Doc edits.
* en/Gtk/ContainerChild.xml
* en/Gtk/Drag.xml
* en/Gtk/Draw.xml
* en/Gtk/CellViewMenuItem.xml
* en/Gtk/DisconnectProxyArgs.xml
* en/Gtk/CellView.xml
* en/Gtk/Container.xml: added docs.
2005-01-02 Shane Landrum <epicene@pobox.com>
* en/Gtk/ComboBox.xml

View File

@ -124,10 +124,13 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Re-inserts <paramref name="cell"/> at <paramref name="position"/>.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<remarks></remarks>
<remarks>
Note that <paramref name="cell"/> has already to be packed
into its view for this to function properly.
</remarks>
</Docs>
</Member>
<Member MemberName="PackEnd">
@ -141,10 +144,14 @@
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Adds the <paramref name="cell"/> into the end of the cell layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks></remarks>
<remarks>
If <paramref name="expand"/> is <see langword="false"/>, then the
<paramref name="cell"/> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is <see langword="true"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="PackStart">
@ -158,10 +165,14 @@
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Packs the <paramref name="cell"/> into the beginning of the cell layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks></remarks>
<remarks>
If <paramref name="expand"/> is <see langword="false"/>, then the
<paramref name="cell"/> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is <see langword="true"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="AddAttribute">
@ -176,11 +187,18 @@
<Parameter Name="column" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Adds an attribute mapping to the list for this cell layout.
</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="attribute">a <see cref="T:System.String" /></param>
<param name="column">a <see cref="T:System.Int32" /></param>
<remarks></remarks>
<param name="attribute">a <see cref="T:System.String" />, parameter on <paramref name="cell"/> to be set from the value</param>
<param name="column">a <see cref="T:System.Int32" />, column of the model to get a value from.</param>
<remarks>
The <paramref name="column"/> is the column of the model to get a value from, and the <paramref name="attribute"/> is the
parameter on <paramref name="cell"/> to be set from the value. So for example if column 2
of the model contains strings, you could have the "text" attribute of a
<see cref="T:Gtk.ComboBox"/> get its values from column 2.
</remarks>
</Docs>
</Member>
<Member MemberName="ClearAttributes">
@ -193,7 +211,8 @@
<Parameter Name="cell" Type="Gtk.CellRenderer" />
</Parameters>
<Docs>
<summary>To be added</summary>
Clears all existing attributes previously set with
<see cref="M:Gtk.CellView.SetAttributes"/>.
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<remarks></remarks>
</Docs>
@ -206,7 +225,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Unsets all the mappings on all renderers for this cell view.</summary>
<remarks></remarks>
</Docs>
</Member>
@ -351,12 +370,17 @@
<Parameter Name="destroy" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets a data function to use for the cell layout.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:System.IntPtr" /></param>
<remarks></remarks>
<remarks>
The data function
is used instead of the standard attributes mapping for setting the
column value, and should set the value of the cell renderer
as appropriate. <paramref name="func"/> may be <see langword="null"/> to remove an older one.
</remarks>
</Docs>
</Member>
</Members>

View File

@ -9,7 +9,7 @@
</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>
<summary>A cell view that's used to represent a menu item.</summary>
<remarks></remarks>
</Docs>
<Base>

View File

@ -273,7 +273,7 @@ class ComboBoxSample
Note that <paramref name="cell"/> has already to be packed
into the combo box for this to function properly.
</remarks>
</Docs>
</Docs>i
</Member>
<Member MemberName="PackEnd">
<MemberSignature Language="C#" Value="public virtual void PackEnd (Gtk.CellRenderer cell, bool expand);" />
@ -286,7 +286,7 @@ class ComboBoxSample
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary></summary>
<summary>Adds the @cell to the end of the combo box.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks>
@ -308,10 +308,14 @@ class ComboBoxSample
<Parameter Name="expand" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Adds the <paramref name="cell"/> to the end of the combo box.</summary>
<summary>Packs the <paramref name="cell"/> into the beginning of the combo box.</summary>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="expand">a <see cref="T:System.Boolean" /></param>
<remarks></remarks>
<remarks>
If <paramref name="expand"/> is <see langword="false"/>, then the
<paramref name="cell"/> is allocated no more space than it needs. Any unused space is
divided evenly between cells for which <paramref name="expand"/> is <see langword="true"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="AddAttribute">
@ -562,8 +566,6 @@ Default value: 0
</Parameters>
<Docs>
<summary>Sets a data function to use for the combo box.</summary>
<param name="renderer">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="func">a <see cref="T:Gtk.CellLayoutDataFunc" /></param>
<param name="func_data">a <see cref="T:System.IntPtr" /></param>

View File

@ -621,7 +621,7 @@
<param name="marshal">a <see cref="T:Gtk.CallbackMarshal" /></param>
<param name="callback_data">a <see cref="T:System.IntPtr" /></param>
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Item">

View File

@ -10,7 +10,7 @@
<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>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -28,7 +28,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="child">
@ -41,7 +41,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -57,7 +57,7 @@
<param name="parent">a <see cref="T:Gtk.Container" /></param>
<param name="child">a <see cref="T:Gtk.Widget" /></param>
<returns>a <see cref="T:Gtk.Container+ContainerChild" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Parent">
@ -70,7 +70,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.Container" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Child">
@ -83,7 +83,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>

View File

@ -39,9 +39,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The action being disconnected from a proxy.</summary>
<returns>a <see cref="T:Gtk.Action" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Proxy">
@ -52,10 +52,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The proxy from which an action is being disconnected.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -526,10 +526,12 @@
<Parameter Name="widget" Type="Gtk.Widget" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Gets the list of targets this widget can provide for drag-and-drop.
</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<returns>a <see cref="T:Gtk.TargetList" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Gtk.TargetList" />, or <see langword="null"/> if none.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SourceSetTargetList">
@ -543,10 +545,14 @@
<Parameter Name="target_list" Type="Gtk.TargetList" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>
Changes the target types that this widget offers for drag-and-drop.
The widget must first be made into a drag source with
gtk_drag_source_set().
</summary>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="target_list">a <see cref="T:Gtk.TargetList" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SetDefaultIcon">
@ -563,14 +569,19 @@
<Parameter Name="hot_y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Obsolete.</summary>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="pixmap">a <see cref="T:Gdk.Pixmap" /></param>
<param name="mask">a <see cref="T:Gdk.Pixmap" /></param>
<param name="hot_x">a <see cref="T:System.Int32" /></param>
<param name="hot_y">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks>
Old functionality: changes the default drag icon. GTK+ retains references for the
arguments, and will release them when they are no longer needed.
This function is obsolete. The default icon should now be changed
via the stock system by changing the stock pixbuf for #GTK_STOCK_DND.
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,7 +10,7 @@
<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>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -44,7 +44,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Diamond">
@ -73,7 +73,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BoxGap">
@ -108,7 +108,7 @@
<param name="gap_side">a <see cref="T:System.Int32" /></param>
<param name="gap_x">a <see cref="T:System.Int32" /></param>
<param name="gap_width">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Extension">
@ -139,7 +139,7 @@
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="gap_side">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Expander">
@ -164,7 +164,7 @@
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="expander_style">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Focus">
@ -189,7 +189,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Arrow">
@ -222,7 +222,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Tab">
@ -251,7 +251,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Box">
@ -280,7 +280,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Layout">
@ -307,7 +307,7 @@
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="layout">a <see cref="T:Pango.Layout" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Hline">
@ -332,7 +332,7 @@
<param name="x1">a <see cref="T:System.Int32" /></param>
<param name="x2">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Option">
@ -361,7 +361,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ResizeGrip">
@ -390,7 +390,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="FlatBox">
@ -419,7 +419,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="String">
@ -444,7 +444,7 @@
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="str1ng">a <see cref="T:System.String" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Handle">
@ -475,7 +475,7 @@
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="orientation">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ShadowGap">
@ -510,7 +510,7 @@
<param name="gap_side">a <see cref="T:System.Int32" /></param>
<param name="gap_x">a <see cref="T:System.Int32" /></param>
<param name="gap_width">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Check">
@ -539,7 +539,7 @@
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Polygon">
@ -566,7 +566,7 @@
<param name="points">a <see cref="T:Gdk.Point" /></param>
<param name="npoints">a <see cref="T:System.Int32" /></param>
<param name="fill">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Vline">
@ -591,7 +591,7 @@
<param name="y1_">a <see cref="T:System.Int32" /></param>
<param name="y2_">a <see cref="T:System.Int32" /></param>
<param name="x">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Slider">
@ -622,7 +622,7 @@
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="orientation">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="InsertionCursor">
@ -649,7 +649,7 @@
<param name="is_primary">a <see cref="T:System.Boolean" /></param>
<param name="direction">a <see cref="T:System.Int32" /></param>
<param name="draw_arrow">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -660,7 +660,7 @@
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.Draw" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>