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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.dataview.DataViewColumn:
==========================================================================================================================================
|phoenix_title| **wx.dataview.DataViewColumn**
==========================================================================================================================================
This class represents a column in a :ref:`wx.dataview.DataViewCtrl`.
One :ref:`wx.dataview.DataViewColumn` is bound to one column in the data model to which the :ref:`wx.dataview.DataViewCtrl` has been associated.
An instance of :ref:`wx.dataview.DataViewRenderer` is used by this class to render its data.
.. note::
In wxGTK, setting the width of the column doesn't happen immediately when :meth:`SetWidth` is called, but only slightly later and :meth:`GetWidth` will return the old width (0 initially) until this happens. If the column widths are set before :ref:`wx.dataview.DataViewCtrl` is initially shown, they will only be effectively set when it becomes visible.
|
|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>DataViewColumn</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.dataview.DataViewColumn_inheritance.png" alt="Inheritance diagram of DataViewColumn" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.dataview.DataViewColumn.html" title="wx.dataview.DataViewColumn" alt="" coords="5,160,227,189"/> <area shape="rect" id="node2" href="wx.SettableHeaderColumn.html" title="wx.SettableHeaderColumn" alt="" coords="18,83,214,112"/> <area shape="rect" id="node3" href="wx.HeaderColumn.html" title="wx.HeaderColumn" alt="" coords="45,5,187,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.dataview.DataViewColumn.__init__` Constructs a text column.
:meth:`~wx.dataview.DataViewColumn.GetModelColumn` Returns the index of the column of the model, which this :ref:`wx.dataview.DataViewColumn` is displaying.
:meth:`~wx.dataview.DataViewColumn.GetOwner` Returns the owning :ref:`wx.dataview.DataViewCtrl`.
:meth:`~wx.dataview.DataViewColumn.GetRenderer` Returns the renderer of this :ref:`wx.dataview.DataViewColumn`.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.dataview.DataViewColumn.Alignment` See :meth:`~wx.dataview.DataViewColumn.GetAlignment` and :meth:`~wx.dataview.DataViewColumn.SetAlignment`
:attr:`~wx.dataview.DataViewColumn.Bitmap` See :meth:`~wx.dataview.DataViewColumn.GetBitmap` and :meth:`~wx.dataview.DataViewColumn.SetBitmap`
:attr:`~wx.dataview.DataViewColumn.Flags` See :meth:`~wx.dataview.DataViewColumn.GetFlags` and :meth:`~wx.dataview.DataViewColumn.SetFlags`
:attr:`~wx.dataview.DataViewColumn.MinWidth` See :meth:`~wx.dataview.DataViewColumn.GetMinWidth` and :meth:`~wx.dataview.DataViewColumn.SetMinWidth`
:attr:`~wx.dataview.DataViewColumn.ModelColumn` See :meth:`~wx.dataview.DataViewColumn.GetModelColumn`
:attr:`~wx.dataview.DataViewColumn.Owner` See :meth:`~wx.dataview.DataViewColumn.GetOwner`
:attr:`~wx.dataview.DataViewColumn.Renderer` See :meth:`~wx.dataview.DataViewColumn.GetRenderer`
:attr:`~wx.dataview.DataViewColumn.SortOrder` See :meth:`~wx.dataview.DataViewColumn.IsSortOrderAscending` and :meth:`~wx.dataview.DataViewColumn.SetSortOrder`
:attr:`~wx.dataview.DataViewColumn.Title` See :meth:`~wx.dataview.DataViewColumn.GetTitle` and :meth:`~wx.dataview.DataViewColumn.SetTitle`
:attr:`~wx.dataview.DataViewColumn.Width` See :meth:`~wx.dataview.DataViewColumn.GetWidth` and :meth:`~wx.dataview.DataViewColumn.SetWidth`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.dataview.DataViewColumn(SettableHeaderColumn)
**Possible constructors**::
DataViewColumn(title, renderer, model_column, width=DVC_DEFAULT_WIDTH,
align=ALIGN_CENTER, flags=DATAVIEW_COL_RESIZABLE)
DataViewColumn(bitmap, renderer, model_column, width=DVC_DEFAULT_WIDTH,
align=ALIGN_CENTER, flags=DATAVIEW_COL_RESIZABLE)
This class represents a column in a DataViewCtrl.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, title, renderer, model_column, width=DVC_DEFAULT_WIDTH, align=ALIGN_CENTER, flags=DATAVIEW_COL_RESIZABLE)`
Constructs a text column.
:param `title`: The title of the column.
:type `title`: string
:param `renderer`: The class which will render the contents of this column.
:type `renderer`: wx.dataview.DataViewRenderer
:param `model_column`: The index of the model's column which is associated with this object.
:type `model_column`: int
:param `width`: The width of the column. The ``DVC_DEFAULT_WIDTH`` value is the fixed default value.
:type `width`: int
:param `align`: The alignment of the column title.
:type `align`: wx.Alignment
:param `flags`: One or more flags of the :ref:`wx.dataview.DataViewColumnFlags` enumeration.
:type `flags`: int
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, bitmap, renderer, model_column, width=DVC_DEFAULT_WIDTH, align=ALIGN_CENTER, flags=DATAVIEW_COL_RESIZABLE)`
Constructs a bitmap column.
:param `bitmap`: The bitmap of the column.
:type `bitmap`: wx.BitmapBundle
:param `renderer`: The class which will render the contents of this column.
:type `renderer`: wx.dataview.DataViewRenderer
:param `model_column`: The index of the model's column which is associated with this object.
:type `model_column`: int
:param `width`: The width of the column. The ``DVC_DEFAULT_WIDTH`` value is the fixed default value.
:type `width`: int
:param `align`: The alignment of the column title.
:type `align`: wx.Alignment
:param `flags`: One or more flags of the :ref:`wx.dataview.DataViewColumnFlags` enumeration.
:type `flags`: int
:html:`<hr class="overloadsep" /><br />`
.. method:: GetModelColumn(self)
Returns the index of the column of the model, which this :ref:`wx.dataview.DataViewColumn` is displaying.
:rtype: `int`
.. method:: GetOwner(self)
Returns the owning :ref:`wx.dataview.DataViewCtrl`.
:rtype: :ref:`wx.dataview.DataViewCtrl`
.. method:: GetRenderer(self)
Returns the renderer of this :ref:`wx.dataview.DataViewColumn`.
:rtype: :ref:`wx.dataview.DataViewRenderer`
.. seealso:: :ref:`wx.dataview.DataViewRenderer`.
.. attribute:: Alignment
See :meth:`~wx.dataview.DataViewColumn.GetAlignment` and :meth:`~wx.dataview.DataViewColumn.SetAlignment`
.. attribute:: Bitmap
See :meth:`~wx.dataview.DataViewColumn.GetBitmap` and :meth:`~wx.dataview.DataViewColumn.SetBitmap`
.. attribute:: Flags
See :meth:`~wx.dataview.DataViewColumn.GetFlags` and :meth:`~wx.dataview.DataViewColumn.SetFlags`
.. attribute:: MinWidth
See :meth:`~wx.dataview.DataViewColumn.GetMinWidth` and :meth:`~wx.dataview.DataViewColumn.SetMinWidth`
.. attribute:: ModelColumn
See :meth:`~wx.dataview.DataViewColumn.GetModelColumn`
.. attribute:: Owner
See :meth:`~wx.dataview.DataViewColumn.GetOwner`
.. attribute:: Renderer
See :meth:`~wx.dataview.DataViewColumn.GetRenderer`
.. attribute:: SortOrder
See :meth:`~wx.dataview.DataViewColumn.IsSortOrderAscending` and :meth:`~wx.dataview.DataViewColumn.SetSortOrder`
.. attribute:: Title
See :meth:`~wx.dataview.DataViewColumn.GetTitle` and :meth:`~wx.dataview.DataViewColumn.SetTitle`
.. attribute:: Width
See :meth:`~wx.dataview.DataViewColumn.GetWidth` and :meth:`~wx.dataview.DataViewColumn.SetWidth`
|