.. include:: headings.inc



.. _DialogLayoutAdapter:

==========================================================================================================================================
|phoenix_title|  **DialogLayoutAdapter**
==========================================================================================================================================

This abstract class is the base for classes that help wxWidgets perform run-time layout adaptation of dialogs.          

Principally, this is to cater for small displays by making part of the dialog scroll, but the application developer may find other uses for layout adaption. 

By default, there is one instance of StandardDialogLayoutAdapter which can perform adaptation for most custom dialogs and dialogs with book controls such as `PropertySheetDialog`. 







         



.. seealso:: :ref:`Automatic scrolling dialogs <automatic scrolling dialogs>`    







|

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

Inheritance diagram for class **DialogLayoutAdapter**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/DialogLayoutAdapter_inheritance.png" alt="Inheritance diagram of DialogLayoutAdapter" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="DialogLayoutAdapter.html" title="This abstract class is the base for classes that help wxWidgets perform run-time layout adaptation of dialogs." alt="" coords="7,5,180,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~DialogLayoutAdapter.__init__`                                            Default constructor.
:meth:`~DialogLayoutAdapter.CanDoLayoutAdaptation`                               Override this to returns ``True`` if adaptation can and should be done.
:meth:`~DialogLayoutAdapter.DoLayoutAdaptation`                                  Override this to perform layout adaptation, such as making parts of the dialog scroll and resizing the dialog to fit the display.
================================================================================ ================================================================================


|


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

.. class:: DialogLayoutAdapter(object)

   This abstract class is the base for classes that help wxWidgets perform run-time layout adaptation of dialogs.
   
   **Possible constructors**::

       DialogLayoutAdapter()
       



   .. method:: __init__(self)

      Default constructor.                   





   .. method:: CanDoLayoutAdaptation(self, dialog)

      Override this to returns ``True`` if adaptation can and should be done.                  


      :param `dialog`: 
      :type `dialog`: Dialog




      :rtype: `bool`








   .. method:: DoLayoutAdaptation(self, dialog)

      Override this to perform layout adaptation, such as making parts of the dialog scroll and resizing the dialog to fit the display.                  

      Normally this function will be called just before the dialog is shown.                  


      :param `dialog`: 
      :type `dialog`: Dialog




      :rtype: `bool`