.. XrcDialog documentation master file, created by
   sphinx-quickstart on Wed Apr 18 15:19:17 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to XrcDialog's documentation!
=====================================

XrcDialog is a small collection of classes, that try to speed up the creation of simple wxPython Dialogs 
loaded from an xrc resource file.

This is how XrcDialog works:

- Design a dialog called 'Dialog' with some xrc editor.

- Define the *dialog data* you are intressted in as a dictionary of *data items*.

- Each control in the dialog modifies the *dialog data* through an attached validator
  derived from a generic validator class CValidator

- Usually, a control modifies a single *data item* through a more specialized
  validator, CSingleItemValidator. 

- This validator mediates between the control's value and the data item's value
  trough a transfer function.
  
Have a look at the example to see XrcDialog in action


Contents:

.. toctree::
   :maxdepth: 2

   example
   xrc_dialog
   validators
   transfer
   validator_mixins



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`