GtkSharp/doc/en/Gtk/NodeSelection.xml

<Type Name="NodeSelection" FullName="Gtk.NodeSelection">
  <TypeSignature Language="C#" Value="public class NodeSelection" Maintainer="auto" />
  <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.8.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>Accessing and manipulates the selected rows of a <see cref="T:Gtk.NodeView" />.</summary>
    <remarks />
    <since version="Gtk# 2.4" />
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Members>
    <Member MemberName="NodeIsSelected">
      <MemberSignature Language="C#" Value="public bool NodeIsSelected (Gtk.ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Tests if a specified node is currently selected.</summary>
        <param name="node">a <see cref="T:Gtk.ITreeNode" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="PathIsSelected">
      <MemberSignature Language="C#" Value="public bool PathIsSelected (Gtk.TreePath path);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="path" Type="Gtk.TreePath" />
      </Parameters>
      <Docs>
        <summary>Tests if a specified path is currently selected.</summary>
        <param name="path">a <see cref="T:Gtk.TreePath" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SelectAll">
      <MemberSignature Language="C#" Value="public void SelectAll ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Selects all the nodes in the view.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SelectNode">
      <MemberSignature Language="C#" Value="public void SelectNode (Gtk.ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Selects a specified node in the view.</summary>
        <param name="node">a <see cref="T:Gtk.ITreeNode" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SelectPath">
      <MemberSignature Language="C#" Value="public void SelectPath (Gtk.TreePath path);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="path" Type="Gtk.TreePath" />
      </Parameters>
      <Docs>
        <summary>Selects a node by path.</summary>
        <param name="path">a <see cref="T:Gtk.TreePath" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SelectRange">
      <MemberSignature Language="C#" Value="public void SelectRange (Gtk.ITreeNode begin_node, Gtk.ITreeNode end_node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="begin_node" Type="Gtk.ITreeNode" />
        <Parameter Name="end_node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Selects all the nodes in a specified range.</summary>
        <param name="begin_node">a <see cref="T:Gtk.ITreeNode" /></param>
        <param name="end_node">a <see cref="T:Gtk.ITreeNode" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="UnselectAll">
      <MemberSignature Language="C#" Value="public void UnselectAll ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Unselects all the nodes in the view.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="UnselectNode">
      <MemberSignature Language="C#" Value="public void UnselectNode (Gtk.ITreeNode node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Unselects a specified node.</summary>
        <param name="node">a <see cref="T:Gtk.ITreeNode" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="UnselectPath">
      <MemberSignature Language="C#" Value="public void UnselectPath (Gtk.TreePath path);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="path" Type="Gtk.TreePath" />
      </Parameters>
      <Docs>
        <summary>Unselects a specified node by path.</summary>
        <param name="path">a <see cref="T:Gtk.TreePath" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="UnselectRange">
      <MemberSignature Language="C#" Value="public void UnselectRange (Gtk.TreePath begin, Gtk.TreePath end);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="begin" Type="Gtk.TreePath" />
        <Parameter Name="end" Type="Gtk.TreePath" />
      </Parameters>
      <Docs>
        <summary>Unselects all the nodes in a specified range.</summary>
        <param name="begin">a <see cref="T:Gtk.TreePath" /></param>
        <param name="end">a <see cref="T:Gtk.TreePath" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="UnselectRange">
      <MemberSignature Language="C#" Value="public void UnselectRange (Gtk.ITreeNode begin_node, Gtk.ITreeNode end_node);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="begin_node" Type="Gtk.ITreeNode" />
        <Parameter Name="end_node" Type="Gtk.ITreeNode" />
      </Parameters>
      <Docs>
        <summary>Unselects all the nodes in a specified range.</summary>
        <param name="begin_node">a <see cref="T:Gtk.ITreeNode" /></param>
        <param name="end_node">a <see cref="T:Gtk.ITreeNode" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Mode">
      <MemberSignature Language="C#" Value="public Gtk.SelectionMode Mode { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.SelectionMode</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Selection mode currently is use.</summary>
        <value>a <see cref="T:Gtk.SelectionMode" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="NodeView">
      <MemberSignature Language="C#" Value="public Gtk.NodeView NodeView { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.NodeView</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The view associated with this selection object.</summary>
        <value>a <see cref="T:Gtk.NodeView" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SelectedNodes">
      <MemberSignature Language="C#" Value="public Gtk.ITreeNode[] SelectedNodes { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.ITreeNode[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The currently selected nodes.</summary>
        <value>a <see cref="T:Gtk.ITreeNode[]" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Changed">
      <MemberSignature Language="C#" Value="public event EventHandler Changed;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The currently selected row(s) changed.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SelectedNode">
      <MemberSignature Language="C#" Value="public Gtk.ITreeNode SelectedNode { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.ITreeNode</ReturnType>
      </ReturnValue>
      <Exception cref="T:System.InvalidOperationException">The Multiple selection mode is in use.</Exception>
      <Docs>
        <summary>The selected node</summary>
        <value>The currently selected node</value>
        <remarks>
          This property does not make sense in the Multiple selection mode. Therefore
          it will throw an exception when used under this mode.
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>