GtkSharp/doc/en/Gtk/NodeView.xml

<Type Name="NodeView" FullName="Gtk.NodeView">
  <TypeSignature Language="C#" Maintainer="auto" Value="public class NodeView : Gtk.TreeView" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
    <AssemblyVersion>2.12.0.0</AssemblyVersion>
  </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>Tree and List view.</summary>
    <remarks />
    <since version="Gtk# 2.4" />
  </Docs>
  <Base>
    <BaseTypeName>Gtk.TreeView</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public NodeView (Gtk.NodeStore store);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="store" Type="Gtk.NodeStore" />
      </Parameters>
      <Docs>
        <summary>Constructs a new view for a given <see cref="T:Gtk.NodeStore" />.</summary>
        <param name="store">a <see cref="T:Gtk.NodeStore" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="NodeStore">
      <MemberSignature Language="C#" Value="public Gtk.NodeStore NodeStore { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.NodeStore</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The store containing the view's data.</summary>
        <value>an object of type <see cref="T:Gtk.NodeStore" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="NodeSelection">
      <MemberSignature Language="C#" Value="public Gtk.NodeSelection NodeSelection { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.NodeSelection</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Used to obtain and manipulate the currently selected node(s).</summary>
        <value>an object of type <see cref="T:Gtk.NodeSelection" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="AppendColumn">
      <MemberSignature Language="C#" Value="public Gtk.TreeViewColumn AppendColumn (string title, Gtk.CellRenderer cell, Gtk.NodeCellDataFunc cell_data);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.TreeViewColumn</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="title" Type="System.String" />
        <Parameter Name="cell" Type="Gtk.CellRenderer" />
        <Parameter Name="cell_data" Type="Gtk.NodeCellDataFunc" />
      </Parameters>
      <Docs>
        <summary>Adds a column to the view using a data callback delegate.</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.NodeCellDataFunc" /></param>
        <returns>a <see cref="T:Gtk.TreeViewColumn" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ActivateRow">
      <MemberSignature Language="C#" Value="public void ActivateRow (Gtk.ITreeNode node, Gtk.treeViewColumn coumn);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
        <Parameter Name="column" Type="Gtk.TreeViewColumn" />
      </Parameters>
      <Docs>
        <summary>Collapses a row (hides its child rows, if they exist).</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /></param>
        <param name="column">an object of type <see cref="T:Gtk.TreeViewColumn" /></param>
        <remarks />
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="CollapseRow">
      <MemberSignature Language="C#" Value="public bool CollapseRow (Gtk.ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Activates the cell determined by <paramref name="node" /> and <paramref name="column" />.</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /> identifying the row to be activated</param>
        <remarks />
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="CreateRowDragIcon">
      <MemberSignature Language="C#" Value="public Gdk.Pixmap CreateRowDragIcon (Gtk.ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Pixmap</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>This image is used for a drag icon..</summary>
        <param name="node">a <see cref="T:Gtk.ITreeNode" /></param>
        <remarks />
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="GetBackgroundArea">
      <MemberSignature Language="C#" Value="public Gdk.Rectangle GetBackgroundArea (ITreeNode node, Gtk.TreeViewColumn column);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Rectangle</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
        <Parameter Name="column" Type="Gtk.TreeViewColumn" />
      </Parameters>
      <Docs>
        <summary>Fills the bounding rectangle in tree window coordinates for the cell at the row specified by <paramref name="node" /> and the column specified by <paramref name="column" />.</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /> identifying the row</param>
        <param name="column">an object of type <see cref="T:Gtk.TreeViewColumn" /> identifying the column</param>
        <remarks>See the remark in  <see cref="T:Gtk.TreeView" />.
        </remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="GetCellArea">
      <MemberSignature Language="C#" Value="public Gdk.Rectangle GetCellArea (ITreeNode node, Gtk.TreeViewColumn column);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Rectangle</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
        <Parameter Name="column" Type="Gtk.TreeViewColumn" />
      </Parameters>
      <Docs>
        <summary>Fills the bounding rectangle in tree window coordinates for the cell at the row specified by <paramref name="node" /> and the column specified by <paramref name="column" />.</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /> identifying the row</param>
        <param name="column">an object of type <see cref="T:Gtk.TreeViewColumn" /> identifying the column</param>
        <remarks>See the remark in  <see cref="T:Gtk.TreeView" />.
        </remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="GetNodeAtPos">
      <MemberSignature Language="C#" Value="public ITreeNode GetNodeAtPos (int x, int y);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.ITreeNode</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="System.Int32" />
        <Parameter Name="y" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Finds the ITreeNode at the point (x, y), relative to widget coordinates.</summary>
        <param name="x">an <see cref="T:System.Int32" /> X coordinate</param>
        <param name="y">an <see cref="T:System.Int32" /> Y coordinate</param>
        <returns>an object of type <see cref="T:Gtk.ITreeNode" /></returns>
        <remarks>It is primarily for things like popup menus. This function is only meaningful if TreeView is realized.  This function can return null.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="GetRowExpanded">
      <MemberSignature Language="C#" Value="public bool GetRowExpanded (ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Returns <see langword="true" /> if the node pointed to by <paramref name="node" /> is expanded.</summary>
        <param name="node">an object of type  <see cref="T:Gtk.ITreeNode" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>
        </remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="GetVisibleRange">
      <MemberSignature Language="C#" Value="public bool GetVisibleRange (out ITreeNode startNode, out ITreeNode endNode);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="startNode" Type="Gtk.ITreeNode" RefType="out" />
        <Parameter Name="endNode" Type="Gtk.ITreeNode" RefType="out" />
      </Parameters>
      <Docs>
        <param name="startNode">returns a <see cref="T:Gtk.ITreeNode" /> to the first visible row.</param>
        <param name="endNode">returns a <see cref="T:Gtk.ITreeNode" /> to the last visible row.</param>
        <summary>Gets the visible rows of the view.</summary>
        <returns>
          <see langword="true" /> if the start and end nodes were set.</returns>
        <remarks>Note: there may be invisible nodes between the start and end nodes returned.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="ScrollToCell">
      <MemberSignature Language="C#" Value="public void ScrollToCell (ITreeNode node, TreeViewColumn column, bool use_align, float row_align, float col_align);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
        <Parameter Name="column" Type="Gtk.TreeViewColumn" />
        <Parameter Name="use_align" Type="System.Boolean" />
        <Parameter Name="row_align" Type="System.Single" />
        <Parameter Name="col_align" Type="System.Single" />
      </Parameters>
      <Docs>
        <summary>Moves the alignments of the <see cref="T:Gtk.TreeView" /> to the position specified by <paramref name="column" /> and <paramref name="node" />.</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /> identifying a row to scroll to</param>
        <param name="column">an object of type <see cref="T:Gtk.TreeViewColumn" />identifying a column to scroll to</param>
        <param name="use_align">a <see cref="T:System.Boolean" /></param>
        <param name="row_align">a <see cref="T:System.Single" /></param>
        <param name="col_align">a <see cref="T:System.Single" /></param>
        <remarks>
          <para>
            If <paramref name="column" /> is <see langword="null" />, then no horizontal scrolling occurs. Likewise, if <paramref name="node" /> is <see langword="null" /> no vertical scrolling occurs. At a minimum, one of <paramref name="column" /> or <paramref name="null" /> need to be non-<see langword="null" />. <paramref name="row_align" /> determines where the row is placed, and <paramref name="col_align" /> determines where the column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.
          </para>
          <para>
            If <paramref name="use_align" /> is <see langword="false" />, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the cell onto the screen. This means that the cell will be scrolled to the edge closest to its current position. If the cell is currently visible on the screen, nothing is done.
          </para>
          <para>
            This function only works if the model is set, and <paramref name="node" /> is a valid row on the model. If the model changes before the <see cref="T:Gtk.NodeView" /> is realized, the centered path will be modified to reflect this change.
          </para>
        </remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="SetTooltipCell">
      <MemberSignature Language="C#" Value="public void SetTooltipCell (Tooltip tooltip, ITreeNode node, TreeViewColumn column, CellRenderer renderer);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tooltip" Type="Gtk.Tooltip" />
        <Parameter Name="node" Type="Gtk.ITreeNode" />
        <Parameter Name="column" Type="Gtk.TreeViewColumn" />
        <Parameter Name="cell" Type="Gtk.CellRenderer" />
      </Parameters>
      <Docs>
        <param name="tooltip">an object of type <see cref="T:Gtk.Tooltip" /></param>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /></param>
        <param name="column">an object of type <see cref="T:Gtk.TreeViewColumn" /></param>
        <param name="renderer">an object of type <see cref="T:Gtk.CellRenderer" /></param>
        <summary>Sets the tip area of <paramref name="tooltip" /> to the area which cell occupies in the item pointed to by node. See also <see cref="SetTipArea" />..</summary>
        <remarks></remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="ExpandRow">
      <MemberSignature Language="C#" Value="public void ExpandRow (Gtk.ITreeNode node, bool open_all);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
        <Parameter Name="open_all" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Expands the row at <paramref name="node" /> so its children are visible.</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /> identifying the row to expand</param>
        <param name="open_all">a <see cref="T:System.Boolean" /> to determine whether to recursively expand or just expand immediate children</param>
        <remarks />
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="ExpandToNode">
      <MemberSignature Language="C#" Value="public void ExpandToNode (Gtk.ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Expands the row at <paramref name="node" />. This will also expand all parent rows of <paramref name="node" /> as necessary.</summary>
        <param name="node">an object of type <see cref="T:Gtk.ITreeNode" /> identifying the row to expand</param>
        <remarks />
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public NodeView ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <summary>Public Constructor.</summary>
        <remarks />
      </Docs>
    </Member>
  </Members>
</Type>