.. 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.DataViewIconText:
==========================================================================================================================================
|phoenix_title| **wx.dataview.DataViewIconText**
==========================================================================================================================================
:ref:`wx.dataview.DataViewIconText` is used by :ref:`wx.dataview.DataViewIconTextRenderer` for data transfer.
This class can be converted to and from a `Variant` .
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DataViewIconText:
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.dataview.DataViewCheckIconText`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.dataview.DataViewIconText.__init__` Constructor.
:meth:`~wx.dataview.DataViewIconText.GetBitmapBundle` Gets the associated image.
:meth:`~wx.dataview.DataViewIconText.GetIcon` Gets the icon.
:meth:`~wx.dataview.DataViewIconText.GetText` Gets the text.
:meth:`~wx.dataview.DataViewIconText.SetBitmapBundle` Sets the associated image.
:meth:`~wx.dataview.DataViewIconText.SetIcon` Set the icon.
:meth:`~wx.dataview.DataViewIconText.SetText` Set the text.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.dataview.DataViewIconText.BitmapBundle` See :meth:`~wx.dataview.DataViewIconText.GetBitmapBundle` and :meth:`~wx.dataview.DataViewIconText.SetBitmapBundle`
:attr:`~wx.dataview.DataViewIconText.Icon` See :meth:`~wx.dataview.DataViewIconText.GetIcon` and :meth:`~wx.dataview.DataViewIconText.SetIcon`
:attr:`~wx.dataview.DataViewIconText.Text` See :meth:`~wx.dataview.DataViewIconText.GetText` and :meth:`~wx.dataview.DataViewIconText.SetText`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.dataview.DataViewIconText(Object)
**Possible constructors**::
DataViewIconText(text: str='', bitmap: BitmapBundle=BitmapBundle()) ->
None
DataViewIconText(other : DataViewIconText) -> None
DataViewIconText is used by DataViewIconTextRenderer for data
transfer.
.. method:: __init__(self, *args, **kw)
Constructor.
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self, text: str='', bitmap: BitmapBundle=BitmapBundle())`
:param `text`:
:type `text`: string
:param `bitmap`:
:type `bitmap`: wx.BitmapBundle
:rtype: `None`
:html:`
`
**__init__** `(self, other : DataViewIconText)`
:param `other`:
:type `other`: wx.dataview.DataViewIconText
:rtype: `None`
:html:`
`
.. method:: GetBitmapBundle(self)
Gets the associated image.
:rtype: `BitmapBundle`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. method:: GetIcon(self)
Gets the icon.
This function can only return the icon in the size appropriate for the standard 100% ``DPI`` scaling, use :meth:`GetBitmapBundle` to retrieve image representation suitable for another ``DPI`` scaling value.
:rtype: `Icon`
.. method:: GetText(self)
Gets the text.
:rtype: `str`
.. method:: SetBitmapBundle(self, bitmap : BitmapBundle)
Sets the associated image.
This function allows to provide several representations of the same image, so that the most appropriate one for the current ``DPI`` scaling could be used, and so should be preferred to :meth:`SetIcon` .
:param `bitmap`:
:type `bitmap`: wx.BitmapBundle
:rtype: `None`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. method:: SetIcon(self, icon : Icon)
Set the icon.
Use :meth:`SetBitmapBundle` instead to allow specifying different image representations for different ``DPI`` scaling values.
:param `icon`:
:type `icon`: wx.Icon
:rtype: `None`
.. method:: SetText(self, text : str)
Set the text.
:param `text`:
:type `text`: string
:rtype: `None`
.. attribute:: BitmapBundle
See :meth:`~wx.dataview.DataViewIconText.GetBitmapBundle` and :meth:`~wx.dataview.DataViewIconText.SetBitmapBundle`
.. attribute:: Icon
See :meth:`~wx.dataview.DataViewIconText.GetIcon` and :meth:`~wx.dataview.DataViewIconText.SetIcon`
.. attribute:: Text
See :meth:`~wx.dataview.DataViewIconText.GetText` and :meth:`~wx.dataview.DataViewIconText.SetText`