base-classes.rst 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. .. _class-reference:
  2. odML-Base Classes
  3. =================
  4. These classes are the core data-structures of odML.
  5. To sum things up, an odML-Document consists of several Sections.
  6. Each Section may contain other Sections and Properties.
  7. Again each Property can have multiple Values.
  8. The odml Module contains wrappers, that are shortcuts for creating the main objects::
  9. >>> from odml import Document, Section, Property, Value
  10. >>> Document(version=0.9, author="Kermit")
  11. <Doc 0.9 by Kermit (0 sections)>
  12. Several modules exist to extend the implementation.
  13. The ones included in the library are those:
  14. * :py:mod:`odml.tools.event` provides event capabilities, allowing to add change-listeners to objects
  15. * :py:mod:`odml.tools.nodes` provides a tree-interface used by the gui with functions like next() and position()
  16. Document
  17. --------
  18. .. autoclass:: odml.doc.BaseDocument
  19. :members:
  20. :inherited-members:
  21. :undoc-members:
  22. Section
  23. -------
  24. .. autoclass:: odml.section.BaseSection
  25. :members:
  26. :inherited-members:
  27. :undoc-members:
  28. Property
  29. --------
  30. .. autoclass:: odml.property.BaseProperty
  31. :members:
  32. :inherited-members:
  33. :undoc-members:
  34. Value
  35. -----
  36. .. autoclass:: odml.value.BaseValue
  37. :members:
  38. :inherited-members:
  39. :undoc-members: