File: wx.grid.GridCellActivatableEditor.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 (125 lines) | stat: -rw-r--r-- 4,310 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
.. 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.grid.GridCellActivatableEditor:

==========================================================================================================================================
|phoenix_title|  **wx.grid.GridCellActivatableEditor**
==========================================================================================================================================

Base class for activatable editors.          

Inheriting from this class makes it simpler to implement editors that support only activation, but not in-place editing, as they only need to implement :meth:`~wx.grid.GridCellActivatableEditor.TryActivate`, :meth:`~wx.grid.GridCellActivatableEditor.DoActivate`  and :meth:`~wx.grid.GridCellActivatableEditor.Clone`  methods, but not all the other pure virtual methods of :ref:`wx.grid.GridCellEditor`. 

         



.. versionadded:: 4.1/wxWidgets-3.1.4  
     







|

|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>GridCellActivatableEditor</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.GridCellActivatableEditor_inheritance.png" alt="Inheritance diagram of GridCellActivatableEditor" 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.grid.GridCellActivatableEditor.html" title="wx.grid.GridCellActivatableEditor" alt="" coords="93,160,332,189"/> <area shape="rect" id="node2" href="wx.grid.GridCellEditor.html" title="wx.grid.GridCellEditor" alt="" coords="131,83,295,112"/> <area shape="rect" id="node3" href="wx.SharedClientDataContainer.html" title="wx.SharedClientDataContainer" alt="" coords="5,5,228,35"/> <area shape="rect" id="node4" href="wx.RefCounter.html" title="wx.RefCounter" alt="" coords="251,5,369,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.grid.GridCellActivatableEditor.DoActivate`                            Same method as in :ref:`wx.grid.GridCellEditor`, but pure virtual.
:meth:`~wx.grid.GridCellActivatableEditor.TryActivate`                           Same method as in :ref:`wx.grid.GridCellEditor`, but pure virtual.
================================================================================ ================================================================================


|


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


.. class:: wx.grid.GridCellActivatableEditor(GridCellEditor)

   Base class for activatable editors.



   .. method:: DoActivate(self, row, col, grid)

      Same method as in :ref:`wx.grid.GridCellEditor`, but pure virtual.                  


      :param `row`: 
      :type `row`: int
      :param `col`: 
      :type `col`: int
      :param `grid`: 
      :type `grid`: wx.grid.Grid







   .. method:: TryActivate(self, row, col, grid, actSource)

      Same method as in :ref:`wx.grid.GridCellEditor`, but pure virtual.                  

      Note that the implementation of this method must never return :meth:`wx.grid.GridActivationResult.DoEdit`   for the editors inheriting from this class, as it doesn't support normal editing.                  


      :param `row`: 
      :type `row`: int
      :param `col`: 
      :type `col`: int
      :param `grid`: 
      :type `grid`: wx.grid.Grid
      :param `actSource`: 
      :type `actSource`: wx.grid.GridActivationSource




      :rtype: :ref:`wx.grid.GridActivationResult`