.. include:: headings.inc

.. currentmodule:: lib.anchors

.. highlight:: python



.. _lib.anchors.LayoutAnchors:

==========================================================================================================================================
|phoenix_title|  **LayoutAnchors**
==========================================================================================================================================

A class that implements Delphi's Anchors with wx.LayoutConstraints.

Anchored sides maintain the distance from the edge of the control
to the same edge of the parent.  When neither side is selected,
the control keeps the same relative position to both sides.

The current position and size of the control and it's parent is
used when setting up the constraints. To change the size or
position of an already anchored control, set the constraints to
None, reposition or resize and reapply the anchors.

Examples::

    Let's anchor the right and bottom edge of a control and
    resize it's parent.

    ctrl.SetConstraints(LayoutAnchors(ctrl, left=0, top=0, right=1, bottom=1))

    +=========+         +===================+
    | +-----+ |         |                   |
    | |     * |   ->    |                   |
    | +--*--+ |         |           +-----+ |
    +---------+         |           |     * |
                        |           +--*--+ |
                        +-------------------+
    * = anchored edge

    When anchored on both sides the control will stretch horizontally.

    ctrl.SetConstraints(LayoutAnchors(ctrl, 1, 0, 1, 1))

    +=========+         +===================+
    | +-----+ |         |                   |
    | *     * |   ->    |                   |
    | +--*--+ |         | +---------------+ |
    +---------+         | *     ctrl      * |
                        | +-------*-------+ |
                        +-------------------+
    * = anchored edge
    



|

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

Inheritance diagram for class **LayoutAnchors**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.anchors.LayoutAnchors_inheritance.png" alt="Inheritance diagram of LayoutAnchors" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="LayoutConstraints.html" title="LayoutConstraints" alt="" coords="247,5,399,35"/> <area shape="rect" id="node6" href="lib.anchors.LayoutAnchors.html" title="A class that implements Delphi's Anchors with wx.LayoutConstraints." alt="" coords="449,5,644,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`LayoutConstraints`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.anchors.LayoutAnchors.__init__`                                      
:meth:`~lib.anchors.LayoutAnchors.setConstraintSides`                            
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: LayoutAnchors(LayoutConstraints)

   A class that implements Delphi's Anchors with wx.LayoutConstraints.
   
   Anchored sides maintain the distance from the edge of the control
   to the same edge of the parent.  When neither side is selected,
   the control keeps the same relative position to both sides.
   
   The current position and size of the control and it's parent is
   used when setting up the constraints. To change the size or
   position of an already anchored control, set the constraints to
   None, reposition or resize and reapply the anchors.
   
   Examples::
   
       Let's anchor the right and bottom edge of a control and
       resize it's parent.
   
       ctrl.SetConstraints(LayoutAnchors(ctrl, left=0, top=0, right=1, bottom=1))
   
       +=========+         +===================+
       | +-----+ |         |                   |
       | |     * |   ->    |                   |
       | +--*--+ |         |           +-----+ |
       +---------+         |           |     * |
                           |           +--*--+ |
                           +-------------------+
       * = anchored edge
   
       When anchored on both sides the control will stretch horizontally.
   
       ctrl.SetConstraints(LayoutAnchors(ctrl, 1, 0, 1, 1))
   
       +=========+         +===================+
       | +-----+ |         |                   |
       | *     * |   ->    |                   |
       | +--*--+ |         | +---------------+ |
       +---------+         | *     ctrl      * |
                           | +-------*-------+ |
                           +-------------------+
       * = anchored edge
       

   .. method:: __init__(self, control, left=1, top=1, right=0, bottom=0)


   .. method:: setConstraintSides(self, side1, side1Edge, side1Anchor, side2, side2Edge, side2Anchor, size, sizeEdge, centre, cPos, cSize, pSize, parent)