[frames] | no frames]

[ Module Hierarchy | Class Hierarchy ]

# Module Hierarchy

- Camelot.camelot: Camelot is a python GUI framework on top of Elixir / Sqlalchemy inspired by the Django admin interface. Start building applications at warp speed, simply by adding some additional information to you Elixir model.
  - Camelot.camelot.action: The action module contains various QAction classes, representing commands that can be invoked via menus, toolbar buttons, and keyboard shortcuts.
    - Camelot.camelot.action.refresh: The action module contains various QAction classes, representing commands that can be invoked via menus, toolbar buttons, and keyboard shortcuts.
    - Camelot.camelot.action.utils: Manage QAction objects
  - Camelot.camelot.admin: @TODO: rewrite docstring
    - Camelot.camelot.admin.application_action
    - Camelot.camelot.admin.application_admin
    - Camelot.camelot.admin.entity_admin
    - Camelot.camelot.admin.form_action: Form actions are objects that can be put in the form_actions list of the object admin interfaces. Those actions then appear on the form and can be executed by the end users. The most convenient method to create custom actions is to subclass FormAction and implement a custom run method
    - Camelot.camelot.admin.list_action
    - Camelot.camelot.admin.not_editable_admin: Class decorator to make all fields visualized with the Admin into read-only fields
    - Camelot.camelot.admin.object_admin: Admin class for Plain Old Python Object
    - Camelot.camelot.admin.section
    - Camelot.camelot.admin.validator: Validator classes validate data before their GUI representation is closed by the user. The validator class also takes care of informing the user where the data is invalid.
      - Camelot.camelot.admin.validator.entity_validator
      - Camelot.camelot.admin.validator.object_validator
  - Camelot.camelot.bin: Command line tools to create new Camelot projects and manage existing ones.
    - Camelot.camelot.bin.camelot_admin: camelot_admin is a tool to assist in the creation and development of Camelot projects.
    - Camelot.camelot.bin.camelot_manage: camelot_manage is oriented towards administrators of an installed camelot application.
  - Camelot.camelot.container: Container classes are classes that are used to transport data between the model thread and the GUI thread.
  - Camelot.camelot.core
    - Camelot.camelot.core.backup
    - Camelot.camelot.core.constants: Created on Jul 19, 2009
    - Camelot.camelot.core.document: Decorators to enhance the docstrings of classes
    - Camelot.camelot.core.files
      - Camelot.camelot.core.files.storage
    - Camelot.camelot.core.resources: wrapper around pkg_resources, with fallback to using directories specified in the settings file if pkg_resources cannot be used.
    - Camelot.camelot.core.schema_display: Created on Aug 29, 2009
    - Camelot.camelot.core.sql
    - Camelot.camelot.core.utils: Utility functions
  - Camelot.camelot.empty_project: Some boilerplate code for an empty project
    - Camelot.camelot.empty_project.application_admin
    - Camelot.camelot.empty_project.main
    - Camelot.camelot.empty_project.model
    - Camelot.camelot.empty_project.settings
  - Camelot.camelot.model
    - Camelot.camelot.model.authentication
    - Camelot.camelot.model.batch_job: Classes to store the result of batch jobs to enable the user to review or plan them
    - Camelot.camelot.model.fixture
    - Camelot.camelot.model.i18n
    - Camelot.camelot.model.memento
    - Camelot.camelot.model.synchronization
    - Camelot.camelot.model.type_and_status: Created on Sep 25, 2009
  - Camelot.camelot.test: Camelot unittest framework
    - Camelot.camelot.test.test_field_attributes: test module for the 'camelot/view/field_attributes.py' module
  - Camelot.camelot.types: Camelot extends the SQLAlchemy field types with a number of its own field types.
  - Camelot.camelot.view
    - Camelot.camelot.view.application_admin
    - Camelot.camelot.view.art: Manages icons and artworks
    - Camelot.camelot.view.controls
      - Camelot.camelot.view.controls.action_widget: Created on May 22, 2010
      - Camelot.camelot.view.controls.actionsbox: Actions box
      - Camelot.camelot.view.controls.appscheme: Encapsulates various ms office schemes
      - Camelot.camelot.view.controls.busy_widget
      - Camelot.camelot.view.controls.calculator
      - Camelot.camelot.view.controls.dashboard
      - Camelot.camelot.view.controls.decorated_line_edit
      - Camelot.camelot.view.controls.delegates: Camelot includes a number of Qt delegates, most of them are used as default delegates for the various sqlalchemy and camelot field types.
        - Camelot.camelot.view.controls.delegates.booldelegate
        - Camelot.camelot.view.controls.delegates.codedelegate
        - Camelot.camelot.view.controls.delegates.colordelegate
        - Camelot.camelot.view.controls.delegates.coloredfloatdelegate
        - Camelot.camelot.view.controls.delegates.comboboxdelegate
        - Camelot.camelot.view.controls.delegates.currencydelegate
        - Camelot.camelot.view.controls.delegates.customdelegate
        - Camelot.camelot.view.controls.delegates.datedelegate
        - Camelot.camelot.view.controls.delegates.datetimedelegate
        - Camelot.camelot.view.controls.delegates.delegatemanager
        - Camelot.camelot.view.controls.delegates.enumerationdelegate
        - Camelot.camelot.view.controls.delegates.filedelegate
        - Camelot.camelot.view.controls.delegates.floatdelegate
        - Camelot.camelot.view.controls.delegates.imagedelegate
        - Camelot.camelot.view.controls.delegates.integerdelegate
        - Camelot.camelot.view.controls.delegates.intervalsdelegate
        - Camelot.camelot.view.controls.delegates.labeldelegate
        - Camelot.camelot.view.controls.delegates.many2onedelegate
        - Camelot.camelot.view.controls.delegates.manytomanydelegate
        - Camelot.camelot.view.controls.delegates.manytoonechoicesdelegate
        - Camelot.camelot.view.controls.delegates.notedelegate
        - Camelot.camelot.view.controls.delegates.one2manydelegate
        - Camelot.camelot.view.controls.delegates.plaintextdelegate
        - Camelot.camelot.view.controls.delegates.richtextdelegate
        - Camelot.camelot.view.controls.delegates.smileydelegate
        - Camelot.camelot.view.controls.delegates.stardelegate
        - Camelot.camelot.view.controls.delegates.texteditdelegate
        - Camelot.camelot.view.controls.delegates.timedelegate
        - Camelot.camelot.view.controls.delegates.virtualaddressdelegate
      - Camelot.camelot.view.controls.editors: Camelot includes editors for various types of fields. Each editor at least supports these features :
        - Camelot.camelot.view.controls.editors.abstractmanytooneeditor
        - Camelot.camelot.view.controls.editors.booleditor
        - Camelot.camelot.view.controls.editors.choiceseditor
        - Camelot.camelot.view.controls.editors.codeeditor
        - Camelot.camelot.view.controls.editors.coloredfloateditor
        - Camelot.camelot.view.controls.editors.coloreditor
        - Camelot.camelot.view.controls.editors.customeditor
        - Camelot.camelot.view.controls.editors.dateeditor
        - Camelot.camelot.view.controls.editors.datetimeeditor
        - Camelot.camelot.view.controls.editors.embeddedmany2oneeditor
        - Camelot.camelot.view.controls.editors.fileeditor
        - Camelot.camelot.view.controls.editors.floateditor
        - Camelot.camelot.view.controls.editors.imageeditor
        - Camelot.camelot.view.controls.editors.integereditor
        - Camelot.camelot.view.controls.editors.labeleditor
        - Camelot.camelot.view.controls.editors.many2oneeditor
        - Camelot.camelot.view.controls.editors.manytomanyeditor
        - Camelot.camelot.view.controls.editors.noteeditor
        - Camelot.camelot.view.controls.editors.one2manyeditor
        - Camelot.camelot.view.controls.editors.onetomanychoiceseditor
        - Camelot.camelot.view.controls.editors.richtexteditor
        - Camelot.camelot.view.controls.editors.smileyeditor
        - Camelot.camelot.view.controls.editors.stareditor
        - Camelot.camelot.view.controls.editors.textediteditor
        - Camelot.camelot.view.controls.editors.textlineeditor
        - Camelot.camelot.view.controls.editors.timeeditor
        - Camelot.camelot.view.controls.editors.virtualaddresseditor
        - Camelot.camelot.view.controls.editors.wideeditor
      - Camelot.camelot.view.controls.exception: Functions and widget to represent exceptions to the user
      - Camelot.camelot.view.controls.field_label
      - Camelot.camelot.view.controls.filter_operator
      - Camelot.camelot.view.controls.filterlist: Controls to filter data
      - Camelot.camelot.view.controls.formview: form view
      - Camelot.camelot.view.controls.inheritance: Controls related to visualizing object hierarchy
      - Camelot.camelot.view.controls.liteboxview
      - Camelot.camelot.view.controls.modeltree: custom tree and tree-items widgets
      - Camelot.camelot.view.controls.navpane: left navigation pane
      - Camelot.camelot.view.controls.printer: class to handle printing
      - Camelot.camelot.view.controls.progress_dialog: Functions and classes to use a progress dialog in combination with a model thread
      - Camelot.camelot.view.controls.search
      - Camelot.camelot.view.controls.statusbar: A custom status bar containing a progress indicator
      - Camelot.camelot.view.controls.tableview: Tableview
      - Camelot.camelot.view.controls.user_translatable_label
      - Camelot.camelot.view.controls.view: Functionallity common to TableViews and FormViews
    - Camelot.camelot.view.elixir_admin
    - Camelot.camelot.view.export
      - Camelot.camelot.view.export.desktop_service
      - Camelot.camelot.view.export.excel
      - Camelot.camelot.view.export.outlook
      - Camelot.camelot.view.export.printer
      - Camelot.camelot.view.export.word
    - Camelot.camelot.view.field_attributes: Field types handled through introspection :
    - Camelot.camelot.view.fifo
    - Camelot.camelot.view.filters: Python structures to represent filters. These structures can be transformed to QT forms.
    - Camelot.camelot.view.forms: Classes to layout fields on a form. These are mostly used for specifying the form_display attribute in Admin classes, but they can be used on their own as well. Form classes can be used recursive.
    - Camelot.camelot.view.main: Main function, to be called to start the GUI interface
    - Camelot.camelot.view.mainwindow
    - Camelot.camelot.view.model_thread
      - Camelot.camelot.view.model_thread.no_thread_model_thread: Created on Sep 12, 2009
      - Camelot.camelot.view.model_thread.signal_slot_model_thread: Created on Sep 9, 2009
    - Camelot.camelot.view.plugins: Plugins to include custom Camelot editors into QT Designer
      - Camelot.camelot.view.plugins.codeeditorplugin
      - Camelot.camelot.view.plugins.dateeditorplugin
      - Camelot.camelot.view.plugins.imageeditorplugin
      - Camelot.camelot.view.plugins.manytooneeditorplugin
      - Camelot.camelot.view.plugins.onetomanyeditorplugin
      - Camelot.camelot.view.plugins.richtexteditorplugin
    - Camelot.camelot.view.proxy: Proxy objects for the model that live in the GUI thread and are able to respond immediately. They do so by keeping a local copy of the data of the real model
      - Camelot.camelot.view.proxy.collection_proxy: Proxy representing a collection of entities that live in the model thread.
      - Camelot.camelot.view.proxy.queryproxy: Proxies representing the results of a query
    - Camelot.camelot.view.remote_signals: Classes to connect the QT event loop with a messaging server. To enable multiple clients to push model updates to each other or messages for the users.
    - Camelot.camelot.view.response_handler: QT Response handler class to be used when constructing a model thread. Construct this response handler within the GUI thread to have all responses being handled within the event loop of the GUI thread.
    - Camelot.camelot.view.search: Helper functions to search through a collection of entities
    - Camelot.camelot.view.storage
    - Camelot.camelot.view.templates
    - Camelot.camelot.view.utils: Helper functions for the view subpackage
    - Camelot.camelot.view.wizard: The wizard module contains generic wizards and wizard pages
      - Camelot.camelot.view.wizard.backup
      - Camelot.camelot.view.wizard.importwizard: Module for managing imports
      - Camelot.camelot.view.wizard.new: Wizard and wizard pages to assist in the creation of new objects
      - Camelot.camelot.view.wizard.new_company
      - Camelot.camelot.view.wizard.pages
        - Camelot.camelot.view.wizard.pages.form_page
        - Camelot.camelot.view.wizard.pages.progress_page: Created on Jan 7, 2010
        - Camelot.camelot.view.wizard.pages.select
        - Camelot.camelot.view.wizard.pages.update_entities_page: Created on Jan 18, 2010
      - Camelot.camelot.view.wizard.update_value: A wizard to update a field on a collection of objects
    - Camelot.camelot.view.workspace: This module provides a singleton workspace that can be used by views and widget to create new windows or raise existing ones