.. include:: headings.inc

.. module:: tools.XRCed.component

.. currentmodule:: tools.XRCed.component

.. highlight:: python



.. _tools.XRCed.component:

==========================================================================================================================================
|phoenix_title|  **component**
==========================================================================================================================================

Component plugin classes.

This module defines base classes and for deriving component plugin
classes and contains some global variables used to register components
with XRCed.

Components are objects of Component class or one of the derived
classes used to define specialized components (such as sizers). After
a component object is constructed and configured it can be registered
using the Manager global object.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for module **component**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/tools.XRCed.component_inheritance.png" alt="Inheritance diagram of component" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="tools.XRCed.component.SimpleComponent.html" title="Component without window attributes and styles." alt="" coords="559,31,796,62"/> <area shape="rect" id="node2" href="tools.XRCed.component.Component.html" title="Base class for component plugins." alt="" coords="319,58,508,89"/> <area shape="rect" id="node12" href="tools.XRCed.component.Container.html" title="Base class for containers." alt="" coords="588,85,767,115"/> <area shape="rect" id="node4" href="tools.XRCed.component.BoxSizer.html" title="Sizers are not windows and have common implicit node." alt="" coords="1316,31,1487,62"/> <area shape="rect" id="node5" href="tools.XRCed.component.Sizer.html" title="Sizers are not windows and have common implicit node." alt="" coords="1121,31,1265,62"/> <area shape="rect" id="node9" href="tools.XRCed.component._ComponentManager.html" title="Component manager used to register component plugins." alt="" coords="7,5,268,35"/> <area shape="rect" id="node10" href="tools.XRCed.component.SmartContainer.html" title="Base class for containers with implicit nodes." alt="" coords="848,31,1069,62"/> <area shape="rect" id="node14" href="tools.XRCed.component.RootComponent.html" title="Special root component." alt="" coords="848,85,1069,115"/> <area shape="rect" id="node16" href="tools.XRCed.component.SimpleContainer.html" title="Container without window attributes and styles." alt="" coords="845,138,1072,169"/> </map> 
   </p>

|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`tools.XRCed.component._ComponentManager`                                   Component manager used to register component plugins.
:ref:`tools.XRCed.component.BoxSizer`                                            Sizers are not windows and have common implicit node.
:ref:`tools.XRCed.component.Component`                                           Base class for component plugins.
:ref:`tools.XRCed.component.Container`                                           Base class for containers.
:ref:`tools.XRCed.component.RootComponent`                                       Special root component.
:ref:`tools.XRCed.component.SimpleComponent`                                     Component without window attributes and styles.
:ref:`tools.XRCed.component.SimpleContainer`                                     Container without window attributes and styles.
:ref:`tools.XRCed.component.Sizer`                                               Sizers are not windows and have common implicit node.
:ref:`tools.XRCed.component.SmartContainer`                                      Base class for containers with implicit nodes.
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   tools.XRCed.component._ComponentManager
   tools.XRCed.component.BoxSizer
   tools.XRCed.component.Component
   tools.XRCed.component.Container
   tools.XRCed.component.RootComponent
   tools.XRCed.component.SimpleComponent
   tools.XRCed.component.SimpleContainer
   tools.XRCed.component.Sizer
   tools.XRCed.component.SmartContainer