File: wx.DialogLayoutAdapter.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (143 lines) | stat: -rw-r--r-- 3,993 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.DialogLayoutAdapter:

==========================================================================================================================================
|phoenix_title|  **wx.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 :ref:`wx.adv.PropertySheetDialog`. 







         



.. seealso:: :ref:`Automatic Scrolled Dialogs <automatic scrolled dialogs>`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>DialogLayoutAdapter</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.DialogLayoutAdapter_inheritance.png" alt="Inheritance diagram of DialogLayoutAdapter" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.DialogLayoutAdapter.html" title="wx.DialogLayoutAdapter" alt="" coords="5,5,181,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.DialogLayoutAdapter.__init__`                                         Default constructor.
:meth:`~wx.DialogLayoutAdapter.CanDoLayoutAdaptation`                            Override this to returns ``True`` if adaptation can and should be done.
:meth:`~wx.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:: wx.DialogLayoutAdapter(object)

   **Possible constructors**::

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



   .. 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`: wx.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`: wx.Dialog




      :rtype: `bool`