<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="dispatch.xsl" ?>
<Object name="Selection" project="SuperEdi">

  <Title>Selection Object</Title>

  <Description>The Selection object represents the current
    selection and cursor position in a document.
  </Description>

  <Keywords>Selection, CurrentColumn, CurrentLine, Text,
    Cut, Copy, Paste, Delete</Keywords>
  
  <!-- Properties -->

  <Property name="Application" type="Application" write="no">
  	<Description>Returns the Application object.</Description>
  </Property>

  <Property name="CurrentColumn" type="long">
  	<Description>Sets or returns the column where the insertion
  	  point is.</Description>
  </Property>

  <Property name="CurrentLine" type="long">
  	<Description>Sets or returns the line where the insertion 
  	  point is.
  	  When the property value is set, it will also reset the CurrentColumn
  	  property to zero. Therefore, to move the cursor, set CurrentLine first
  	  and CurrentColumn afterwards.</Description>
  </Property>

  <Property name="FirstColumn" type="long">
  	<Description>Sets or returns the first column of the current selection.</Description>
  </Property>

  <Property name="FirstLine" type="long">
  	<Description>Sets or returns the first line of the current selection.</Description>
  </Property>

  <Property name="LastColumn" type="long">
  	<Description>Sets or returns the last column of the current selection.</Description>
  </Property>

  <Property name="LastLine" type="long">
  	<Description>Sets or returns the last line of the current selection.</Description>
  </Property>

  <Property name="Parent" type="Document" write="no">
  	<Description>Returns the Document object.</Description>
  </Property>

  <Property name="StringAtCursor" type="string" write="no">
  	<Description>Returns the current selected text if any. Otherwise
		if there's a quoted  string around the current cursor position,
		this string is returned, otherwise an empty string.</Description>
  </Property>

  <Property name="Text" type="string">
  	<Description>Sets or returns the the text in a selection.</Description>
  </Property>

  <Property name="WordAtCursor" type="string" write="no">
  	<Description>Returns the current selected text if any. Otherwise
		returns the word around the current cursor position.
	</Description>
  </Property>

  <!-- Methods -->

  <Method name="Copy">
	<Description>Copies the selected text to the Clipboard.</Description>
    <Syntax>celection.Copy()</Syntax>
  </Method>

  <Method name="Cut">
	<Description>Removes the selected text and adds it to the
	  Clipboard.</Description>
    <Syntax>celection.Cut()</Syntax>
  </Method>

  <Method name="Delete">
	<Description>Removes the selected text.</Description>
    <Syntax>celection.Delete()</Syntax>
  </Method>

  <Method name="Paste">
	<Description>Replaces a selection with the contents of the 
	  Clipboard.</Description>
    <Syntax>celection.Paste()</Syntax>
  </Method>

</Object>
