2004-08-04 Shane Landrum <epicene@pobox.com>

* en/Gtk/*: docs for many tree-related methods,
	assorted others.

svn path=/trunk/gtk-sharp/; revision=31876
This commit is contained in:
Shane Landrum 2004-08-04 17:10:22 +00:00
parent da65bf9dc1
commit b64284f794
25 changed files with 345 additions and 305 deletions

View File

@ -1,3 +1,8 @@
2004-08-04 Shane Landrum <epicene@pobox.com>
* en/Gtk/*: docs for many tree-related methods,
assorted others.
2004-08-01 Shane Landrum <epicene@pobox.com>
* en/Pango/*: Filled in all "To be added"; cleaned

View File

@ -181,9 +181,9 @@ class Y {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Gets the one and only child widget of this Bin object.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -219,10 +219,10 @@ class Y {
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Bin" /></returns>
<remarks>To be added</remarks>
<remarks>Chain to this constructor if you have not manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -89,7 +89,7 @@
<summary>Sets the renderer size to be explicit, independent of the properties set.</summary>
<param name="width">an object of type <see cref="T:System.Int32" /></param>
<param name="height">an object of type <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetFixedSize">
@ -103,10 +103,10 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="width">an object of type <see cref="T:System.Int32" /></param>
<param name="height">an object of type <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>Fills in <paramref name="width" /> and <paramref name="height" /> with the appropriate size of <paramref name="cell" />.</summary>
<param name="width">an <see cref="T:System.Int32" /> for the width</param>
<param name="height">an <see cref="T:System.Int32" /> for the height</param>
<remarks />
</Docs>
</Member>
<Member MemberName="Activate">
@ -376,9 +376,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A protected constructor. (FIXME: elaborate.)</summary>
<returns>a <see cref="T:Gtk.CellRenderer" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSize">
@ -421,14 +421,14 @@
<Parameter Name="flags" Type="Gtk.CellRendererState" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">a <see cref="T:Gdk.Drawable" /></param>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="background_area">a <see cref="T:Gdk.Rectangle" /></param>
<param name="cell_area">a <see cref="T:Gdk.Rectangle" /></param>
<param name="expose_area">a <see cref="T:Gdk.Rectangle" /></param>
<param name="flags">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>Invokes the virtual render function of the <see cref="M:CellRenderer" />. The three passed-in rectangles are areas of window. Most renderers will draw within <paramref name="cell_area"/>; the xalign, yalign, xpad, and ypad fields of the <see cref="M:CellRenderer" /> should be honored with respect to <paramref name="cell_area"/>. <paramref name="background_area"/> includes the blank space around the cell, and also the area containing the tree expander; so the <paramref name="background_area"/> rectangles for all cells tile to cover the entire window. <paramref name="expose_area" /> is a clip rectangle.</summary>
<param name="window">a <see cref="T:Gdk.Drawable" /> to render to</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, the widget that owns <paramref name="window" /></param>
<param name="background_area">a <see cref="T:Gdk.Rectangle" />, entire cell area (including tree expanders and maybe padding on the sides)</param>
<param name="cell_area">a <see cref="T:Gdk.Rectangle" />, area normally rendered by a cell renderer</param>
<param name="expose_area">a <see cref="T:Gdk.Rectangle" />, area that needs updating</param>
<param name="flags">a <see cref="T:System.Int32" />, flags that affect rendering</param>
<remarks />
</Docs>
</Member>
<Member MemberName="StartEditing">
@ -454,8 +454,8 @@
<param name="cell_area">a <see cref="T:Gdk.Rectangle" /></param>
<param name="flags">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.CellEditable" /></returns>
<remarks>To be added</remarks>
<remarks>Some cell renderers may use events; for example, <see cref="T:CellRendererToggle" /> toggles when it gets a mouse click.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -303,8 +303,9 @@ Tags should be in the <see cref="T:Gtk.TextTagTable" /> for a given <see cref="T
<Docs>
<summary>Pixels of blank space between wrapped lines in a paragraph</summary>
<param name="value">pixels of blank space</param>
<returns>Pixels of blank space between wrapped lines in a paragraph</returns>&gt;
<remarks>To be added</remarks></Docs>
<returns>An integer</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="PixelsBelowLines">
<MemberSignature Language="C#" Value="public int PixelsBelowLines { set; get; };" />
@ -690,8 +691,8 @@ Default value: 400
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever this text tag explicitly fires an event; general-purpose event.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -742,4 +743,4 @@ Default value: 400
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -907,8 +907,8 @@ class TextViewSample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the adjustment values for the scrollbars are set.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="SetAnchor">
@ -919,8 +919,8 @@ class TextViewSample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever an anchor (e.g. <see cref="M:Gtk.TextChildAnchor" />) is set within the TextView. </summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="MoveCursor">
@ -931,8 +931,8 @@ class TextViewSample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the cursor is moved.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="PopulatePopup">
@ -1003,8 +1003,8 @@ class TextViewSample
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the insert/overwrite flag is toggled.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="CutClipboard">
@ -1339,4 +1339,4 @@ class TextViewSample
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -39,10 +39,10 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Holds the new title for the window.</summary>
<returns>the new title.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -57,7 +57,7 @@
<Parameters />
<Docs>
<summary>Adds a new space to the beginning of the toolbar.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="UnsetStyle">
@ -82,8 +82,8 @@
<Docs>
<summary>
Unsets toolbar icon size set with <see cref="P:Gtk.Toolbar.IconSize" />.
</summary>
<remarks>To be added</remarks>
</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="InsertWidget">
@ -122,7 +122,7 @@
<param name="widget">A <see cref="T:Gtk.Widget" /> to add to the toolbar.</param>
<param name="tooltip_text">The tooltip for the element.</param>
<param name="tooltip_private_text">Used for context-sensitive help about this toolbar element.</param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendSpace">
@ -134,7 +134,7 @@
<Parameters />
<Docs>
<summary>Adds a new space to the end of the toolbar.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="RemoveSpace">
@ -149,7 +149,7 @@
<Docs>
<summary>Removes a space from the specified position.</summary>
<param name="position">The index of the space to remove.</param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="PrependWidget">
@ -168,7 +168,7 @@
<param name="widget">a <see cref="T:Gtk.Widget" /> to add to the toolbar.</param>
<param name="tooltip_text">The tooltip for the element.</param>
<param name="tooltip_private_text">Used for context-sensitive help about this toolbar element.</param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="InsertSpace">
@ -183,7 +183,7 @@
<Docs>
<summary>Inserts a new space in the toolbar at the specified position.</summary>
<param name="position">The number of widgets after which a space should be inserted.</param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -222,7 +222,7 @@
<Docs>
<summary>Creates a new toolbar.</summary>
<returns>The newly-created toolbar.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="IconSize">
@ -237,7 +237,7 @@
<summary>This function sets the size of stock icons in the toolbar. You can call it both before you add the icons and after they have been added. The size you set will override user preferences for the default icon size.</summary>
<param name="value">The <see cref="T:Gtk.IconSize" /> that stock icons in the toolbar shall have.</param>
<returns>The icon size for the toolbar.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Tooltips">
@ -252,7 +252,7 @@
<summary>Sets if the tooltips of a toolbar should be active or not.</summary>
<param name="value">set to <see langword="false" /> to disable the tooltips, or <see langword="true" /> to enable them.</param>
<returns>Whether tooltips are enabled.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ToolbarStyle">
@ -267,7 +267,7 @@
<summary>Alters the view of toolbar to display either icons only, text only, or both.</summary>
<param name="value">The new style for toolbar. </param>
<returns>The current style of toolbar.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Orientation">
@ -282,7 +282,7 @@
<summary>Sets the <see cref="T:Gtk.Orientation" /> of the toolbar to either <see cref="T:Gtk.Orientation.Horizontal" /> or <see cref="T:Gtk.Orientation.Vertical" />.</summary>
<param name="value">The orientation of the toolbar.</param>
<returns>The orientation of the toolbar.</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="StyleChanged">
@ -294,7 +294,7 @@
<Parameters />
<Docs>
<summary>Used if you wish to perform an action when the orientation of a toolbar is changed.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="OrientationChanged">
@ -368,16 +368,25 @@
<Parameter Name="cb" Type="Gtk.SignalFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:Gtk.ToolbarChildType" /></param>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="text">a <see cref="T:System.String" /></param>
<param name="tooltip_text">a <see cref="T:System.String" /></param>
<param name="tooltip_private_text">a <see cref="T:System.String" /></param>
<param name="icon">a <see cref="T:Gtk.Widget" /></param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" /></param>
<summary>
<para>
This method is deprecated and should not be used in new code.
</para>
<para>
Adds a new button to the beginning of the toolbar (left or top, depending on toolbar orientation).
</para>
<para>
If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the new element. If type == <see cref="T:Gtk.ToolbarChildType.Radiobutton" />, widget is used to determine the radio group for the new element. In all other cases, widget must be NULL.
</para>
</summary>
<param name="type">a <see cref="T:Gtk.ToolbarChildType" />, the type of widget to add</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, the widget itself</param>
<param name="text">a <see cref="T:System.String" />, a label for the widget</param>
<param name="tooltip_text">a <see cref="T:System.String" />, simple tooltip text</param>
<param name="tooltip_private_text">a <see cref="T:System.String" />, context-sensitive detailed help</param>
<param name="icon">a <see cref="T:Gtk.Widget" />, the icon to use for this widget</param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" />, a callback function to use when the new widget is touched.</param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="InsertElement">
@ -398,18 +407,29 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:Gtk.ToolbarChildType" /></param>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="text">a <see cref="T:System.String" /></param>
<param name="tooltip_text">a <see cref="T:System.String" /></param>
<param name="tooltip_private_text">a <see cref="T:System.String" /></param>
<param name="icon">a <see cref="T:Gtk.Widget" /></param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" /></param>
<param name="user_data">a <see cref="T:System.IntPtr" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<summary>
<para>
This method is deprecated and should not be used in new code.
</para>
<para>
Adds a new button to the beginning of the toolbar (left or top, depending on toolbar orientation).
</para>
<para>
If type == <see cref="T:Gtk.ToolbarChildType.Widget" />, widget is used as the new element. If type == <see cref="T:Gtk.ToolbarChildType.Radiobutton" />, widget is used to determine the radio group for the new element. In all other cases, widget must be NULL.
</para>
</summary>
<param name="type">a <see cref="T:Gtk.ToolbarChildType" />, the type of widget to add</param>
<param name="widget">a <see cref="T:Gtk.Widget" />, the widget itself</param>
<param name="text">a <see cref="T:System.String" />, a label for the widget</param>
<param name="tooltip_text">a <see cref="T:System.String" />, simple tooltip text</param>
<param name="tooltip_private_text">a <see cref="T:System.String" />, context-sensitive detailed help</param>
<param name="icon">a <see cref="T:Gtk.Widget" />, the icon to use for this widget</param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" />, a callback function to use when the new widget is touched.</param>
<param name="user_data">a <see cref="T:System.IntPtr" />, data to pass to the callback.</param>
<param name="position">a <see cref="T:System.Int32" />, the number of toolbar widgets to insert this element after.</param>
<returns>a <see cref="T:Gtk.Widget" />, the new toolbar element.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendItem">
@ -426,14 +446,14 @@
<Parameter Name="cb" Type="Gtk.SignalFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="tooltip_text">a <see cref="T:System.String" /></param>
<param name="tooltip_private_text">a <see cref="T:System.String" /></param>
<param name="icon">a <see cref="T:Gtk.Widget" /></param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="InsertStock">
@ -459,7 +479,7 @@
<param name="user_data">a <see cref="T:System.IntPtr" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="InsertItem">
@ -478,7 +498,7 @@
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="tooltip_text">a <see cref="T:System.String" /></param>
<param name="tooltip_private_text">a <see cref="T:System.String" /></param>
@ -487,7 +507,7 @@
<param name="user_data">a <see cref="T:System.IntPtr" /></param>
<param name="position">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="PrependItem">
@ -504,14 +524,14 @@
<Parameter Name="cb" Type="Gtk.SignalFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="tooltip_text">a <see cref="T:System.String" /></param>
<param name="tooltip_private_text">a <see cref="T:System.String" /></param>
<param name="icon">a <see cref="T:Gtk.Widget" /></param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendElement">
@ -530,7 +550,7 @@
<Parameter Name="cb" Type="Gtk.SignalFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="type">a <see cref="T:Gtk.ToolbarChildType" /></param>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="text">a <see cref="T:System.String" /></param>
@ -539,7 +559,7 @@
<param name="icon">a <see cref="T:Gtk.Widget" /></param>
<param name="cb">a <see cref="T:Gtk.SignalFunc" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -557,4 +577,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -204,4 +204,4 @@ class ToolTipsExample
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,7 +10,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>The data needed for a <see cref="T:Gtk.Tooltips" /></summary>
<summary>The data needed for a <see cref="T:Gtk.Tooltips" /> object.</summary>
<remarks>
</remarks>
</Docs>
@ -91,11 +91,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Generates a Tooltips object out of this data.</summary>
<param name="value">an object of type <see cref="T:Gtk.Tooltips" /></param>
<returns>an object of type <see cref="T:Gtk.Tooltips" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="TipText">
@ -129,4 +127,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -38,12 +38,12 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="selection_data">a <see cref="T:Gtk.SelectionData" /></param>
<param name="tree_model">a <see cref="T:Gtk.TreeModel" /></param>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetRowDragData">
@ -58,12 +58,12 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<param name="selection_data">a <see cref="T:Gtk.SelectionData" /></param>
<param name="tree_model">a <see cref="T:Gtk.TreeModel" /></param>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -72,10 +72,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Deprecated.</summary>
<returns>a <see cref="T:Gtk.Tree" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>An object to represent the rows of a tree when something is drag-and-dropped onto them.</summary>
<remarks />
</Docs>
<Base />
<Interfaces>
@ -32,11 +32,13 @@
<Parameter Name="selection_data" Type="Gtk.SelectionData" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dest_path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="selection_data">To be added: an object of type 'Gtk.SelectionData'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
Determines whether a drop is possible before the given <paramref name="dest" />, at the same depth as <paramref name="dest" />. i.e., can we drop the data in <paramref name="selection_data" /> at that location. <paramref name="dest" /> does not have to exist; the return value will almost certainly be FALSE if the parent of <paramref name="dest" /> doesn't exist, though.
</summary>
<param name="dest">a <see cref='M:Gtk.TreePath' />, the potential drop target</param>
<param name="selection_data">a <see cref='M:Gtk.SelectionData' />, the data to drop</param>
<returns>A boolean for whether the drop is possible.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DragDataReceived">
@ -50,12 +52,16 @@
<Parameter Name="selection_data" Type="Gtk.SelectionData" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dest">To be added: an object of type 'Gtk.TreePath'</param>
<param name="selection_data">To be added: an object of type 'Gtk.SelectionData'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
Asks the TreeDragDest to insert a row before the given <paramref name="dest_path" />, deriving the contents of the row from the given <see cref="M:Gtk.SelectionData" />.
</summary>
<param name="dest_path">a <see cref='M:Gtk.TreePath' />, where to drop the data</param>
<param name="selection_data"> a <see cref='M:Gtk.SelectionData' />, the data to drop</param>
<returns>A boolean for whether the row was dropped successfully.</returns>
<remarks>If dest_path is outside the tree so that inserting before it is impossible, FALSE will be returned. Also, FALSE may be returned if the new row cannot be created for some model-specific reason. Should robustly handle a destination path no longer found in the model.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>An object to represent the rows of a tree when one of them is dragged to another location.</summary>
<remarks />
</Docs>
<Base />
<Interfaces>
@ -32,11 +32,11 @@
<Parameter Name="selection_data" Type="Gtk.SelectionData" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<param name="selection_data">To be added: an object of type 'Gtk.SelectionData'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Asks the <see cref="M:Gtk.TreeDragSource" /> to fill in <paramref name="selection_data" /> with a representation of the row at <paramref name="path" />. Should robustly handle a path no longer found in the model.</summary>
<param name="path">a <see cref="M:Gtk.TreePath"></param>
<param name="selection_data">a <see cref="M:Gtk.SelectionData"> object to fill with data</param>
<returns>A boolean; true if data of the required type was provided.</returns>
<remarks>FIXME: the original doc says, "selection_data->target gives the required type of the data.", but there doesn't seem to be a parallel in Gtk#. Check this.</remarks>
</Docs>
</Member>
<Member MemberName="RowDraggable">
@ -49,10 +49,10 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Check whether the row at <paramref name="path" /> is draggable. If the source doesn't implement this method, the row is assumed to be draggable.</summary>
<param name="path">a <see cref="M:Gtk.TreePath"></param>
<returns>A boolean, true if this row can be dragged.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DragDataDelete">
@ -65,11 +65,13 @@
<Parameter Name="path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">To be added: an object of type 'Gtk.TreePath'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>
Asks the TreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop. Returns FALSE if the deletion fails because path no longer exists, or for some model-specific reason. Should robustly handle a path no longer found in the model.
</summary>
<param name="path">a <see cref="M:Gtk.TreePath"> to delete</param>
<returns>A boolean for whether the deletion succeeded.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -69,10 +69,10 @@
<Parameter Name="iter" Type="Gtk.TreeIter&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added:</summary>
<summary>Sets the TreeIter object pointed to by the iter param to point to the first child of this tree. </summary>
<param name="iter">an object of type <see cref="T:Gtk.TreeIter" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added:</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="EmitRowChanged">
@ -653,10 +653,10 @@
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<summary>Returns the type of the column at the given index.</summary>
<param name="index_">a <see cref="T:System.Int32" />, the column number.</param>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="EmitRowsReordered">
@ -713,4 +713,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>A class that makes an underlying <see cref="M:Gtk.TreeModel" /> sortable.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -1085,4 +1085,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,9 @@
</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>Represents a particular node of a <see cref="T:Gtk.TreeView" />.</summary>
<remarks>A TreePath can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -31,9 +32,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Creates a new GtkTreePath.</summary>
<returns>an object of type <see cref="T:Gtk.TreePath" /></returns>
<remarks>To be added</remarks>
<remarks>The string representation of this path is "0".</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
@ -44,9 +45,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>an object of type <see cref="T:Gtk.TreePath" /></returns>
<remarks>To be added</remarks>
<summary>Copies a TreePath into a new TreePath object.</summary>
<returns>an object of type <see cref="T:Gtk.TreePath" />, the new copy</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="IsDescendant">
@ -59,10 +60,10 @@
<Parameter Name="ancestor" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="ancestor">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Tests whether this TreePath is a descendant of a particular TreePath.</summary>
<param name="ancestor">an object of type <see cref="T:Gtk.TreePath" />, the potential ancestor to test</param>
<returns>an object of type <see cref="T:System.Boolean" />, true if this TreePath is the other TreePath's descendant.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="IsAncestor">
@ -75,10 +76,10 @@
<Parameter Name="descendant" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="descendant">an object of type <see cref="T:Gtk.TreePath" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Tests whether this TreePath is an ancestor of a given TreePath</summary>
<param name="descendant">an object of type <see cref="T:Gtk.TreePath" />, the potential descendant</param>
<returns>an object of type <see cref="T:System.Boolean" />, returns true if this TreePath is an ancestor of the given TreePath.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Down">
@ -89,8 +90,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Changes this TreePath object to refer to its own first child.</summary>
<remarks>FIXME: make sure this is right.</remarks>
</Docs>
</Member>
<Member MemberName="Compare">
@ -103,10 +104,10 @@
<Parameter Name="b" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="b">an object of type <see cref="T:Gtk.TreePath" /></param>
<summary>Compares two paths. If this path appears before <see cref="T:Gtk.TreePath" /> b in a tree, then -1 is returned. If the parameter path appears before this path, then 1 is returned. If the two nodes are equal, then 0 is returned.</summary>
<param name="b">an object of type <see cref="T:Gtk.TreePath" />, the path to compare</param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Free">
@ -117,8 +118,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Disposes of the TreePath object and any resources it was using.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Next">
@ -129,8 +130,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Moves the TreePath to point to the next node at the current depth.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Prev">
@ -141,9 +142,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Moves the TreePath to point to the previous node at the current depth, if it exists.</summary>
<returns>an object of type <see cref="T:System.Boolean" />, true if the path has a previous node and the move was made successfully.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Up">
@ -154,9 +155,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Moves the TreePath to point to its parent node, if it has a parent.</summary>
<returns>an object of type <see cref="T:System.Boolean" />, true if the path has a previous node and the move was made successfully.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -181,9 +182,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Constructor; builds an empty TreePath.</summary>
<returns>an object of type <see cref="T:Gtk.TreePath" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -207,9 +208,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Returns the current depth of the TreePath.</summary>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="PrependIndex">
@ -222,9 +223,9 @@
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>Prepends a new index to a path. As a result, the depth of the path is increased.</summary>
<param name="index_">a <see cref="T:System.Int32" />, the index to prepend</param>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendIndex">
@ -237,9 +238,9 @@
<Parameter Name="index_" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<summary>Appends a new index to a path. As a result, the depth of the path is increased.</summary>
<param name="index_">a <see cref="T:System.Int32" />, the index to append</param>
<remarks />
</Docs>
</Member>
<Member MemberName="Indices">
@ -250,9 +251,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns the current indices of the TreePath. This is an array of integers, each representing a node in a tree. This value should not be freed.</summary>
<returns>a <see cref="T:System.Int32[]" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ToString">
@ -263,9 +264,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Generates a string representation of the TreePath. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -282,4 +283,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -419,12 +419,12 @@ class TreeSelectionSample
<Parameter Name="end_path" Type="Gtk.TreePath" />
</Parameters>
<Docs>
<summary>Unselects everything from one path to another.</summary>
<summary>Unselects everything between one path and another.</summary>
<param name="start_path">
<see cref="T:Gtk.TreePath" /> to begin range.</param>
<param name="end_path">
<see cref="T:Gtk.TreePath" /> to end range.</param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="CountSelectedRows">
@ -437,7 +437,7 @@ class TreeSelectionSample
<Docs>
<summary>Get the number of selected rows.</summary>
<returns>The number of selected rows</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSelected">
@ -513,7 +513,7 @@ class TreeSelectionSample
<summary>Returns an array of <see cref="T:Gtk.TreePath" />s representing the selected rows.</summary>
<param name="model">The model the <see cref="T:Gtk.TreeView" /> is bound to.</param>
<returns>Selected rows in an array of <see cref="T:Gtk.TreePath" />s</returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -522,10 +522,10 @@ class TreeSelectionSample
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.TreeSelection" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -491,8 +491,7 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>Tests if the node represented by the given path is open</summary>
<remarks>To be added</remarks>
<summary>Disables the TreeView as a drag-and-drop destination.</summary>
</Docs>
</Member>
<Member MemberName="AppendColumn">
@ -523,10 +522,10 @@ public class TreeViewDemo {
<Parameter Name="pos" Type="Gtk.TreeViewDropPosition" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" /></param>
<param name="pos">an object of type <see cref="T:Gtk.TreeViewDropPosition" /></param>
<remarks>To be added</remarks>
<summary>Sets the row that is highlighted for drag-and-drop feedback.</summary>
<param name="path">an object of type <see cref="T:Gtk.TreePath" />, the path of the row to highlight, or null.</param>
<param name="pos">an object of type <see cref="T:Gtk.TreeViewDropPosition" />, specifying whether to drop before, after, or into the row.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="UnsetRowsDragSource">
@ -537,8 +536,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Disables the TreeView as a drag source for automatic drag and drop actions.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="CollapseRow">
@ -581,9 +580,9 @@ public class TreeViewDemo {
<Parameter Name="func" Type="Gtk.TreeViewMappingFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="func">an object of type <see cref="T:Gtk.TreeViewMappingFunc" /></param>
<remarks>To be added</remarks>
<summary>Calls the given function on all expanded rows.</summary>
<param name="func">a <see cref="T:Gtk.TreeViewMappingFunc" /> to execute on every expanded row.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="ScrollToPoint">
@ -740,9 +739,9 @@ public class TreeViewDemo {
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The window that this TreeView renders to.</summary>
<returns>an object of type <see cref="T:Gdk.Window" /></returns>
<remarks>To be added</remarks>
<remarks>This property is primarily used to confirm that events on the TreeView are executed within the correct window.</remarks>
</Docs>
</Member>
<Member MemberName="RulesHint">
@ -896,8 +895,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the scrollbar adjustment units are set.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowExpanded">
@ -908,8 +907,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever a row of the TreeView is expanded.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MoveCursor">
@ -920,8 +919,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the cursor is moved on this TreeView.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TestExpandRow">
@ -956,8 +955,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever a row is collapsed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ColumnsChanged">
@ -1094,8 +1093,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever all rows of the TreeView are selected.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="SelectCursorParent">
@ -1107,7 +1106,7 @@ public class TreeViewDemo {
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="UnselectAll">
@ -1118,8 +1117,8 @@ public class TreeViewDemo {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever all rows of the TreeView are specifically deselected.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendColumn">
@ -1165,12 +1164,12 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="cell_data" Type="Gtk.TreeCellDataFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Adds a new <see cref="T:Gtk.TreeViewColumn" /> to the TreeView and returns it.</summary>
<param name="title">a <see cref="T:System.String" /></param>
<param name="cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="cell_data">a <see cref="T:Gtk.TreeCellDataFunc" /></param>
<returns>a <see cref="T:Gtk.TreeViewColumn" /></returns>
<remarks>To be added</remarks>
<remarks>This method actually creates the column, rather than relying on a column object to be passed in. There's an alternate invokation form if you'd like to pass in an existing column object.</remarks>
</Docs>
</Member>
<Member MemberName="SetCursorOnCell">
@ -1186,12 +1185,15 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="start_editing" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the current keyboard focus to be on the given <see cref="T:Gtk.TreePath" />. This is useful for getting the user's attention to a particular row.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="focus_column">a <see cref="T:Gtk.TreeViewColumn" /></param>
<param name="focus_cell">a <see cref="T:Gtk.CellRenderer" /></param>
<param name="start_editing">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks>
<para>If focus_column is not null, then focus is given to the column specified by it. If focus_column and focus_cell are not null, and focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by focus_cell. Additionally, if focus_column is specified, and start_editing is null, then editing should be started in the specified cell.</para>
<para>This function is often followed by<see cref="T:Gtk.Widget.GrabFocus" />(tree_view_obj) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ExpandToPath">
@ -1217,14 +1219,16 @@ tree_view.AppendColumn ("title", text, "text", 0);
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="Gtk.TreePath&amp;" RefType="out" />
<Parameter Name="path" Type="Gtk.TreePath" RefType="out" />
<Parameter Name="focus_column" Type="Gtk.TreeViewColumn&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.TreePath&amp;" /></param>
<summary>
Fills in path and focus_column with the current path and focus column. If the cursor isn't currently set, then path will point to null. If no column currently has focus, then focus_column will be null.
`</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="focus_column">a <see cref="T:Gtk.TreeViewColumn&amp;" /></param>
<remarks>To be added</remarks>
<remarks>The returned path must be freed with <see cref="T:Gtk.TreePath.Free" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetDragDestRow">
@ -1238,10 +1242,10 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="pos" Type="Gtk.TreeViewDropPosition&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:Gtk.TreePath&amp;" /></param>
<param name="pos">a <see cref="T:Gtk.TreeViewDropPosition&amp;" /></param>
<remarks>To be added</remarks>
<summary>Gets information about the row that is highlighted for feedback.</summary>
<param name="path">a <see cref="T:Gtk.TreePath" /> to put the highlighted path into.</param>
<param name="pos">a <see cref="T:Gtk.TreeViewDropPosition" /> to put the drop position into.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetDestRowAtPos">
@ -1257,13 +1261,13 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="pos" Type="Gtk.TreeViewDropPosition&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drag_x">a <see cref="T:System.Int32" /></param>
<param name="drag_y">a <see cref="T:System.Int32" /></param>
<param name="path">a <see cref="T:Gtk.TreePath&amp;" /></param>
<param name="pos">a <see cref="T:Gtk.TreeViewDropPosition&amp;" /></param>
<summary>Determines the destination row for a given XY position. This is used by drag-and-drop operations to determine the target rows for the action.</summary>
<param name="drag_x">a <see cref="T:System.Int32" />, the X coordinate</param>
<param name="drag_y">a <see cref="T:System.Int32" />, the Y coordinate</param>
<param name="path">a <see cref="T:Gtk.TreePath" /> to put the resulting destination row into.</param>
<param name="pos">a <see cref="T:Gtk.TreeViewDropPosition&amp;" /> to indicate where to put the dragged object, relative to the <see cref="T:Gtk.TreePath" /> returned by this method.</param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="TreeToWidgetCoords">
@ -1279,12 +1283,12 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="wy" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tx">a <see cref="T:System.Int32" /></param>
<param name="ty">a <see cref="T:System.Int32" /></param>
<param name="wx">a <see cref="T:System.Int32&amp;" /></param>
<param name="wy">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>
<summary>Converts tree coordinates to widget coordinates. Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.</summary>
<param name="tx">a <see cref="T:System.Int32" />, the X coordinate of the tree location</param>
<param name="ty">a <see cref="T:System.Int32" />, the Y coordinate of the tree location</param>
<param name="wx">a <see cref="T:System.Int32&amp;" />, the X coordinate for the widget</param>
<param name="wy">a <see cref="T:System.Int32&amp;" />, the Y coordinate for the widget</param>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -1315,11 +1319,11 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="actions" Type="Gdk.DragAction" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_button_mask">a <see cref="T:Gdk.ModifierType" /></param>
<param name="targets">a <see cref="T:Gtk.TargetEntry[]" /></param>
<param name="actions">a <see cref="T:Gdk.DragAction" /></param>
<remarks>To be added</remarks>
<summary>Allows the TreeView to be used as a source for drag-and-drop actions.</summary>
<param name="start_button_mask">a <see cref="T:Gdk.ModifierType" />, the mask of the allowed buttons for starting a drag</param>
<param name="targets">a <see cref="T:Gtk.TargetEntry[]" />, a table of supported targets for dragging to</param>
<param name="actions">a <see cref="T:Gdk.DragAction" />, what should be done with the dragged data.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="EnableModelDragDest">
@ -1333,10 +1337,10 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="actions" Type="Gdk.DragAction" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="targets">a <see cref="T:Gtk.TargetEntry[]" /></param>
<param name="actions">a <see cref="T:Gdk.DragAction" /></param>
<remarks>To be added</remarks>
<summary>Turns this TreeView object into a destination for automatic drag-and-drop.</summary>
<param name="targets">a <see cref="T:Gtk.TargetEntry[]" />, a table of targets this TreeView will support.</param>
<param name="actions">a <see cref="T:Gdk.DragAction" />, a bitmap of possible actions for a drag to this target</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -1634,9 +1638,9 @@ tree_view.AppendColumn ("title", text, "text", 0);
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>A list of all the columns currently in this TreeView.</summary>
<returns>a <see cref="T:Gtk.TreeViewColumn[]" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetCellArea">
@ -1699,14 +1703,17 @@ tree_view.AppendColumn ("title", text, "text", 0);
</Parameters>
<Docs>
<summary>Finds the path at the point (x, y), relative to widget coordinates.</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="column">a <see cref="T:Gtk.TreeViewColumn" /></param>
<param name="cell_x">a <see cref="T:System.Int32" /></param>
<param name="cell_y">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<param name="x">a <see cref="T:System.Int32" />, an x coordinate</param>
<param name="y">a <see cref="T:System.Int32" />, a y coordinate</param>
<param name="path">a <see cref="T:Gtk.TreePath" /> to fill with the path at the (x,y) coordinate.</param>
<param name="column">a <see cref="T:Gtk.TreeViewColumn" /> to fill with the column at the (x,y) coordinate.</param>
<param name="cell_x">a <see cref="T:System.Int32" /> to fill with the x coordinate relative to the cell background.</param>
<param name="cell_y">a <see cref="T:System.Int32" /> to fill with the y coordinate relative to the cell background.</param>
<returns>a <see cref="T:System.Boolean" />, true if a row exists at (x,y).</returns>
<remarks>
<para>x and y must come from an event on the tree_view only where the event's window is the same as the window this TreeView renders to. It is primarily for things like popup menus. If path is non-null, then it will be filled with the GtkTreePath at that point. This path should be freed with <see cref="T:Gtk.TreePath.Free" />. If column is non-NULL, then it will be filled with the column at that point.</para>
<para>cell_x and cell_y return the coordinates relative to the cell background (i.e. the background_area passed to <see cref="T:Gtk.CellRenderer.Render" />). This function is only meaningful if the TreeView object is realized.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetPathAtPos">
@ -1722,14 +1729,14 @@ tree_view.AppendColumn ("title", text, "text", 0);
<Parameter Name="column" Type="Gtk.TreeViewColumn&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>
<param name="path">a <see cref="T:Gtk.TreePath" /></param>
<param name="column">a <see cref="T:Gtk.TreeViewColumn" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Finds the path at the point (x, y), relative to widget coordinates.</summary>
<param name="x">a <see cref="T:System.Int32" />, an x coordinate</param>
<param name="y">a <see cref="T:System.Int32" />, a y coordinate</param>
<param name="path">a <see cref="T:Gtk.TreePath" /> to fill with the path at the (x,y) coordinate.</param>
<param name="column">a <see cref="T:Gtk.TreeViewColumn" /> to fill with the column at the (x,y) coordinate.</param>
<returns>a <see cref="T:System.Boolean" />, true if a row exists at (x,y)</returns>
<remarks>This is an alternate invocation form which doesn't return coordinates for the position relative to a cell's background.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -40,10 +40,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The <see cref="T:Gtk.UnmapEventHandler" /> uses this method to access the details of an event.</summary>
<returns>a <see cref="T:Gdk.Event" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -7,7 +7,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>Event handler.</summary>
<summary>Event handler. Called whenever a widget is unmapped--- that is, whenever its window is hidden.</summary>
<remarks>
<para>The <see cref="M:Gtk.Widget.UnmapEvent" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.UnmapEventArgs" /> parameter.</para>
@ -34,4 +34,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -37,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Obsolete.</summary>
<remarks>
</remarks>
</Docs>
@ -50,7 +50,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Obsolete.</summary>
<remarks>
</remarks>
</Docs>
@ -63,7 +63,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Obsolete.</summary>
<remarks>
</remarks>
</Docs>
@ -82,4 +82,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -39,10 +39,10 @@
<ReturnType>Gdk.EventVisibility</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.EventVisibility'</returns>
<remarks>To be added</remarks>
<summary>The <see cref="T:Gtk.VisibilityNotifyEventHandler" /> uses this method to access the details of an event.</summary>
<returns>a <see cref="T:Gdk.EventVisibility" /></returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -727,7 +727,7 @@
</Parameters>
<Docs>
<summary>Activates the targets associated with the mnemonic.</summary>
<param name="group_cycling">To be added: an object of type 'bool'</param>
<param name="group_cycling">A boolean; set to true if the list of targets should cycle once the end of the list is reached.</param>
<returns>
<see langword="true" /> if the activation is done.</returns>
<remarks />
@ -1730,8 +1730,8 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever this widget's window is told to hide itself.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Focused">
@ -1742,8 +1742,9 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever this widget is focused.</summary>
<returns> a <see cref="T:Gtk.FocusedHandler" /></returns>
<remarks>The widget gets this signal as the user uses keyboard shortcuts or tabs through the widgets in a window.</remarks>
</Docs>
</Member>
<Member MemberName="ParentSet">
@ -1754,8 +1755,8 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever this widget's parent widget is set.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="KeyReleaseEvent">
@ -1766,8 +1767,8 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a key is released within this widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Hidden">
@ -1778,8 +1779,7 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever this widget is hidden.</summary>
</Docs>
</Member>
<Member MemberName="SelectionRequestEvent">
@ -1802,8 +1802,8 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the text direction for this widget is changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="DragLeave">
@ -1863,7 +1863,7 @@ handle focus grabs.</returns>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="DragBegin">
@ -1910,8 +1910,8 @@ handle focus grabs.</returns>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a key is pressed within this widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MapEvent">
@ -3471,7 +3471,7 @@ handle focus grabs.</returns>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Widget.MotionNotifyEvent" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnMapEvent">
xs <Member MemberName="OnMapEvent">
<MemberSignature Language="C#" Value="protected virtual bool OnMapEvent (Gdk.Event evnt);" />
<MemberType>Method</MemberType>
<ReturnValue>
@ -3992,4 +3992,4 @@ Widgets are required to honor the size allocation they receive; a size request i
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -40,10 +40,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The <see cref="T:Gtk.WidgetEventHandler" /> uses this method to access the details of an event.</summary>
<returns>a <see cref="T:Gdk.Event" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -37,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>This value shows the short name of the tooltip--- the hover text.</summary>
<remarks>
</remarks>
</Docs>
@ -50,7 +50,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>This field holds longer or more detailed help text; so named because it's often used by the "What's this?" help function in many applications.</summary>
<remarks>
</remarks>
</Docs>
@ -69,4 +69,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -39,10 +39,10 @@
<ReturnType>Gdk.EventWindowState</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.EventWindowState'</returns>
<remarks>To be added</remarks>
<summary>The <see cref="T:Gtk.WindowStateEventHandler" /> uses this method to access the details of an event.</summary>
<returns>a <see cref="T:Gdk.EventWindowState" /></returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>