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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
|
.. 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.grid.GridSizesInfo:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridSizesInfo**
==========================================================================================================================================
:ref:`wx.grid.GridSizesInfo` stores information about sizes of all :ref:`wx.grid.Grid` rows or columns.
It assumes that most of the rows or columns (which are both called elements here as the difference between them doesn't matter at this class level) have the default size and so stores it separately. And it uses a :ref:`HashMap` to store the sizes of all elements which have the non-default size.
This structure is particularly useful for serializing the sizes of all :ref:`wx.grid.Grid` elements at once.
|
|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>GridSizesInfo</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.grid.GridSizesInfo_inheritance.png" alt="Inheritance diagram of GridSizesInfo" 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.grid.GridSizesInfo.html" title="wx.grid.GridSizesInfo" alt="" coords="5,5,157,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridSizesInfo.__init__` Default constructor.
:meth:`~wx.grid.GridSizesInfo.GetSize` Get the element size.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.grid.GridSizesInfo.m_sizeDefault` A public C++ attribute of type ``int``. Default size.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridSizesInfo(object)
**Possible constructors**::
GridSizesInfo()
GridSizesInfo(defSize, allSizes)
GridSizesInfo stores information about sizes of all Grid rows or
columns.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
m_sizeDefault and m_customSizes must be initialized later.
**~~~**
**__init__** `(self, defSize, allSizes)`
Constructor.
This constructor is used by :meth:`wx.grid.Grid.GetRowSizes` and GetColSizes() methods. User code will usually use the default constructor instead.
:param `defSize`: The default element size.
:type `defSize`: int
:param `allSizes`: Array containing the sizes of `all` elements, including those which have the default size.
:type `allSizes`: list of integers
**~~~**
.. method:: GetSize(self, pos)
Get the element size.
:param `pos`: The index of the element.
:rtype: `int`
:returns:
The size for this element, using m_customSizes if `pos` is in it or m_sizeDefault otherwise.
.. attribute:: m_sizeDefault
A public C++ attribute of type ``int``. Default size.
|