.. include:: headings.inc



.. currentmodule:: dataview



.. _dataview.DataViewColumn:

==========================================================================================================================================
|phoenix_title|  **DataViewColumn**
==========================================================================================================================================

This class represents a column in a :ref:`dataview.DataViewCtrl`.          

One :ref:`dataview.DataViewColumn`  is bound to one column in the data model to which the :ref:`dataview.DataViewCtrl`  has been associated. 

An instance of :ref:`dataview.DataViewRenderer`  is used by this class to render its data. 









|

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

Inheritance diagram for class **DataViewColumn**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/dataview.DataViewColumn_inheritance.png" alt="Inheritance diagram of DataViewColumn" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="dataview.DataViewColumn.html" title="This class represents a column in a dataview.DataViewCtrl." alt="" coords="421,5,568,35"/> <area shape="rect" id="node2" href="SettableHeaderColumn.html" title="Adds methods to set the column attributes to HeaderColumn." alt="" coords="185,5,372,35"/> <area shape="rect" id="node4" href="HeaderColumn.html" title="Represents a column header in controls displaying tabular data such as dataview.DataViewCtrl  or Grid." alt="" coords="5,5,136,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~DataViewColumn.__init__`                                                 Constructs a text column.
:meth:`~DataViewColumn.GetModelColumn`                                           Returns the index of the column of the model, which this :ref:`dataview.DataViewColumn`  is displaying.
:meth:`~DataViewColumn.GetOwner`                                                 Returns the owning :ref:`dataview.DataViewCtrl`.
:meth:`~DataViewColumn.GetRenderer`                                              Returns the renderer of this :ref:`dataview.DataViewColumn`.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~DataViewColumn.ModelColumn`                                              See :meth:`~DataViewColumn.GetModelColumn`
:attr:`~DataViewColumn.Owner`                                                    See :meth:`~DataViewColumn.GetOwner`
:attr:`~DataViewColumn.Renderer`                                                 See :meth:`~DataViewColumn.GetRenderer`
================================================================================ ================================================================================


|


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

.. class:: DataViewColumn(SettableHeaderColumn)

   This class represents a column in a DataViewCtrl.
   
   **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)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__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`: 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`: Alignment
      :param `flags`: One or more flags of the :meth:`DataViewColumnFlags`   enumeration.   
      :type `flags`: int
      
      
      
      
      
      
      
      
      
      
      
      
      
      
                        
      
      
      
      
      **~~~**

      
      **__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`: Bitmap
      :param `renderer`: The class which will render the contents of this column.   
      :type `renderer`: 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`: Alignment
      :param `flags`: One or more flags of the :meth:`DataViewColumnFlags`   enumeration.   
      :type `flags`: int
      
      
      
      
      
      
      
      
      
      
      
      
      
      
                        
      
      
      
      
      **~~~**






   .. method:: GetModelColumn(self)

      Returns the index of the column of the model, which this :ref:`dataview.DataViewColumn`  is displaying.                  

      :rtype: `int`








   .. method:: GetOwner(self)

      Returns the owning :ref:`dataview.DataViewCtrl`.                  

      :rtype: :ref:`dataview.DataViewCtrl`








   .. method:: GetRenderer(self)

      Returns the renderer of this :ref:`dataview.DataViewColumn`.                  

                

      :rtype: :ref:`dataview.DataViewRenderer`







      .. seealso:: :ref:`dataview.DataViewRenderer`.   








   .. attribute:: ModelColumn

      See :meth:`~DataViewColumn.GetModelColumn`


   .. attribute:: Owner

      See :meth:`~DataViewColumn.GetOwner`


   .. attribute:: Renderer

      See :meth:`~DataViewColumn.GetRenderer`