folia.main.Headspan
===================

.. currentmodule:: folia.main

.. autoclass:: Headspan
   :show-inheritance:
   :undoc-members:
   :special-members:

   

   
   .. rubric:: Method Summary

   .. autosummary::
   
      ~Headspan.__init__
      ~Headspan.accepts
      ~Headspan.add
      ~Headspan.addable
      ~Headspan.addidsuffix
      ~Headspan.addtoindex
      ~Headspan.ancestor
      ~Headspan.ancestors
      ~Headspan.annotation
      ~Headspan.annotations
      ~Headspan.annotator2processor
      ~Headspan.append
      ~Headspan.checkdeclaration
      ~Headspan.context
      ~Headspan.copy
      ~Headspan.copychildren
      ~Headspan.correct
      ~Headspan.count
      ~Headspan.deepvalidation
      ~Headspan.depthfirstsearch
      ~Headspan.description
      ~Headspan.elements
      ~Headspan.feat
      ~Headspan.findcorrectionhandling
      ~Headspan.findreplaceables
      ~Headspan.generate_id
      ~Headspan.getindex
      ~Headspan.getmetadata
      ~Headspan.gettextdelimiter
      ~Headspan.hasannotation
      ~Headspan.hasphon
      ~Headspan.hastag
      ~Headspan.hastext
      ~Headspan.incorrection
      ~Headspan.insert
      ~Headspan.items
      ~Headspan.json
      ~Headspan.layer
      ~Headspan.leftcontext
      ~Headspan.move
      ~Headspan.next
      ~Headspan.originaltext
      ~Headspan.parsecommonarguments
      ~Headspan.parsexml
      ~Headspan.phon
      ~Headspan.phoncontent
      ~Headspan.postappend
      ~Headspan.precedes
      ~Headspan.previous
      ~Headspan.relaxng
      ~Headspan.relaxng_backwards
      ~Headspan.remove
      ~Headspan.replace
      ~Headspan.resolveoffsets
      ~Headspan.resolveword
      ~Headspan.rightcontext
      ~Headspan.select
      ~Headspan.setdoc
      ~Headspan.setdocument
      ~Headspan.setparents
      ~Headspan.setprocessor
      ~Headspan.setspan
      ~Headspan.settext
      ~Headspan.sort
      ~Headspan.speech_speaker
      ~Headspan.speech_src
      ~Headspan.stricttext
      ~Headspan.substitute
      ~Headspan.tag
      ~Headspan.text
      ~Headspan.textcontent
      ~Headspan.textvalidation
      ~Headspan.toktext
      ~Headspan.untag
      ~Headspan.updatetext
      ~Headspan.wrefs
      ~Headspan.xml
      ~Headspan.xmlstring
    
    
    ~Headspan.__iter__
    
    
    
    ~Headspan.__len__
    
    
    
    ~Headspan.__str__
    
    
   
   

   
   
   .. rubric:: Class Attributes

   
   .. autoattribute:: ACCEPTED_DATA
   .. autoattribute:: ANNOTATIONTYPE
   .. autoattribute:: AUTH
   .. autoattribute:: AUTO_GENERATE_ID
   .. autoattribute:: HIDDEN
   .. autoattribute:: IMPLICITSPACE
   .. autoattribute:: LABEL
   .. autoattribute:: OCCURRENCES
   .. autoattribute:: OCCURRENCES_PER_SET
   .. autoattribute:: OPTIONAL_ATTRIBS
   .. autoattribute:: PHONCONTAINER
   .. autoattribute:: PRIMARYELEMENT
   .. autoattribute:: PRINTABLE
   .. autoattribute:: REQUIRED_ATTRIBS
   .. autoattribute:: REQUIRED_DATA
   .. autoattribute:: SETONLY
   .. autoattribute:: SPEAKABLE
   .. autoattribute:: SUBSET
   .. autoattribute:: TEXTCONTAINER
   .. autoattribute:: TEXTDELIMITER
   .. autoattribute:: WREFABLE
   .. autoattribute:: XLINK
   .. autoattribute:: XMLTAG
   
   

   .. rubric:: Method Details

   .. automethod::  __init__
   
   .. automethod:: __init__
   
   .. automethod:: accepts
   
   .. automethod:: add
   
   .. automethod:: addable
   
   .. automethod:: addidsuffix
   
   .. automethod:: addtoindex
   
   .. automethod:: ancestor
   
   .. automethod:: ancestors
   
   .. automethod:: annotation
   
   .. automethod:: annotations
   
   .. automethod:: annotator2processor
   
   .. automethod:: append
   
   .. automethod:: checkdeclaration
   
   .. automethod:: context
   
   .. automethod:: copy
   
   .. automethod:: copychildren
   
   .. automethod:: correct
   
   .. automethod:: count
   
   .. automethod:: deepvalidation
   
   .. automethod:: depthfirstsearch
   
   .. automethod:: description
   
   .. automethod:: elements
   
   .. automethod:: feat
   
   .. automethod:: findcorrectionhandling
   
   .. automethod:: findreplaceables
   
   .. automethod:: generate_id
   
   .. automethod:: getindex
   
   .. automethod:: getmetadata
   
   .. automethod:: gettextdelimiter
   
   .. automethod:: hasannotation
   
   .. automethod:: hasphon
   
   .. automethod:: hastag
   
   .. automethod:: hastext
   
   .. automethod:: incorrection
   
   .. automethod:: insert
   
   .. automethod:: items
   
   .. automethod:: json
   
   .. automethod:: layer
   
   .. automethod:: leftcontext
   
   .. automethod:: move
   
   .. automethod:: next
   
   .. automethod:: originaltext
   
   .. automethod:: parsecommonarguments
   
   .. automethod:: parsexml
   
   .. automethod:: phon
   
   .. automethod:: phoncontent
   
   .. automethod:: postappend
   
   .. automethod:: precedes
   
   .. automethod:: previous
   
   .. automethod:: relaxng
   
   .. automethod:: relaxng_backwards
   
   .. automethod:: remove
   
   .. automethod:: replace
   
   .. automethod:: resolveoffsets
   
   .. automethod:: resolveword
   
   .. automethod:: rightcontext
   
   .. automethod:: select
   
   .. automethod:: setdoc
   
   .. automethod:: setdocument
   
   .. automethod:: setparents
   
   .. automethod:: setprocessor
   
   .. automethod:: setspan
   
   .. automethod:: settext
   
   .. automethod:: sort
   
   .. automethod:: speech_speaker
   
   .. automethod:: speech_src
   
   .. automethod:: stricttext
   
   .. automethod:: substitute
   
   .. automethod:: tag
   
   .. automethod:: text
   
   .. automethod:: textcontent
   
   .. automethod:: textvalidation
   
   .. automethod:: toktext
   
   .. automethod:: untag
   
   .. automethod:: updatetext
   
   .. automethod:: wrefs
   
   .. automethod:: xml
   
   .. automethod:: xmlstring
   
   
   
   .. automethod:: __iter__
   
   
   
   .. automethod:: __len__
   
   
   
   .. automethod:: __str__