Code Documentation

Gramps provides several general API. The most important is the gen module, providing access to all code that can be of interest outside of the Gramps program.

The gen Module

The gen module provides packages that are common to all gramps interfaces (gui, cli and web).

Contents:

• The gramps.gen.lib Module
  • Base objects
  • Primary objects
  • Secondary objects
  • Reference objects
  • Table objects
  • Date objects
  • Text objects
  • Meta data
  • Type classes
  • Privacy
• The gramps.gen Module
  • Database State
  • Errors
  • Recent Files
  • Sort
  • Update callback
  • User
• The gramps.gen.db Module
  • Database Architecture
  • DbBsddb
  • DbDjango
  • GrampsDbBase
  • GrampsDbRead
  • GrampsDbWrite
  • GrampsCursor
  • BSDDBtxn
  • GrampsDbTxn
  • GrampsDbUndo
  • DbConst
  • GrampsDbException
  • Upgrade utilities
  • Backup
• The gramps.gen.display Module
  • Name
• The gramps.gen.plug Module
  • Plugin
  • BaseManager
  • Export
  • Gramplet
  • Import
  • Menu
  • Reports
  • Register
  • Utils
• The gramps.gen.proxy Module
  • Proxy Base
  • Filter
  • Living
  • Private
  • References
• The gramps.gen.utils Module
  • Utilities

The Gramps Application

Contents:

• The cli Module
  • Argument Handler
  • Argument Parser
  • CLI DB manager
  • Gramps CLI
  • User
• The gramps.gui Module
  • Gramps
  • About Dialog
  • Base Sidebar
  • Column Order
  • Configuration
  • GUI Element (DB)
  • DB Loader
  • DB Manager
  • Filter Editor
  • Navigator
  • Plugin Manager
  • User
  • Utils
  • View Manager
• The gramps.gui.widgets Module
  • Basic Entry
  • Buttons
  • Date Entry
  • Expand Collapse Arrow
  • Fanchart
  • Fanchart Descendant
  • Gramplet Bar
  • Gramplet Pane
  • Labels
  • Link Box
  • Menu Item
  • Monitored Widgets
  • Multi Tree View
  • Photo
  • Progress Dialog
  • Shortlist ComboEntry
  • Spring Separator
  • Statusbar
  • Styled Text Buffer
  • Styled Text Editor
  • Tool ComboEntry
  • Undoable Buffer
  • Undoable Entry
  • Undoable Styled Buffer
  • Validated Combo Entry
  • Validated Masked Entry
  • Value Action
  • Value Tool Item
• The Date Handler Classes
  • DateParser
  • DateStrings
  • DateDisplay
  • DateUtils
  • DateHandler
  • Localized Date Handlers
• The Date Edition Classes
  • DateEdit
• The RelationshipCalculator Class
  • Localized Handlers
• The Simple Classes
  • Simple Access
  • Simple Doc
  • Simple Table

Useful snippets

Contents:

• The Html Class