File: wx.dataview.DataViewValueAdjuster.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (127 lines) | stat: -rw-r--r-- 4,172 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
.. 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.DataViewValueAdjuster:

==========================================================================================================================================
|phoenix_title|  **wx.dataview.DataViewValueAdjuster**
==========================================================================================================================================

This class can be used with :meth:`wx.dataview.DataViewRenderer.SetValueAdjuster`   to customize rendering of model values with standard renderers.          

Can be used to change the value if it is shown on a highlighted row (i.e. in selection) which typically has dark background. It is useful in combination with :ref:`wx.dataview.DataViewTextRenderer`  with markup and can be used e.g. to remove background color attributes inside selection, as a lightweight alternative to implementing an entire :ref:`wx.dataview.DataViewCustomRenderer`  specialization. 

::

    # Markup renderer that removes bgcolor attributes when in selection
    class DataViewMarkupRenderer(wx.dataview.DataViewTextRenderer):

        def __init__(self):
            super(DataViewMarkupRenderer, self).__init__()
            self.EnableMarkup()
            self.SetValueAdjuster(DataViewMarkupRenderer._Adjuster())

        class _Adjuster(wx.dataview.DataViewValueAdjuster):
            def MakeHighlighted(self, value):
                pos = value.find(" bgcolor=\"")
                if pos != -1:
                    pos2 = s.find('"', pos + 10)
                    value = value[:pos] + value[pos2+1:]
                return value









.. versionadded:: 4.1/wxWidgets-3.1.1  
    







|

|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>DataViewValueAdjuster</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.DataViewValueAdjuster_inheritance.png" alt="Inheritance diagram of DataViewValueAdjuster" 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.DataViewValueAdjuster.html" title="wx.dataview.DataViewValueAdjuster" alt="" coords="5,5,267,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.dataview.DataViewValueAdjuster.MakeHighlighted`                       Change value for rendering when highlighted.
================================================================================ ================================================================================


|


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


.. class:: wx.dataview.DataViewValueAdjuster(object)

   This class can be used with `DataViewRenderer.SetValueAdjuster()` to
   customize rendering of model values with standard renderers.



   .. method:: MakeHighlighted(self, value)

      Change value for rendering when highlighted.                  

      Override to customize the value when it is shown in a highlighted (selected) row, typically on a dark background. 

      Default implementation returns `value`  unmodified. 

      The `value`  passed to this method is always non-null and it must return a non-null value too.                  


      :param `value`: 
      :type `value`: DVCVariant




      :rtype: :ref:`DVCVariant`