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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.colourchooser.canvas
.. highlight:: python
.. _wx.lib.colourchooser.canvas.Canvas:
==========================================================================================================================================
|phoenix_title| **wx.lib.colourchooser.canvas.Canvas**
==========================================================================================================================================
A canvas class for arbitrary drawing.
The Canvas class implements a window that allows for drawing
arbitrary graphics. It implements a double buffer scheme and
blits the off-screen buffer to the window during paint calls
by the windowing system for speed.
Some other methods for determining the canvas colour and size
are also provided.
|
|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>Canvas</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.lib.colourchooser.canvas.Canvas_inheritance.png" alt="Inheritance diagram of Canvas" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="21,5,123,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="73,83,184,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="69,160,189,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="147,5,228,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="85,237,173,267"/> <area shape="rect" id="node6" href="wx.lib.colourchooser.canvas.Canvas.html" title="wx.lib.colourchooser.canvas.Canvas" alt="" coords="5,315,253,344"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.colourchooser.pycolourslider.PyColourSlider`, :class:`wx.lib.colourchooser.pypalette.PyPalette`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Window`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.colourchooser.canvas.Canvas.__init__` Creates a canvas instance and initializes the off-screen
:meth:`~wx.lib.colourchooser.canvas.Canvas.Blit` Performs the blit of the buffer contents on-screen.
:meth:`~wx.lib.colourchooser.canvas.Canvas.DrawBuffer` Actual drawing function for drawing into the off-screen
:meth:`~wx.lib.colourchooser.canvas.Canvas.GetBoundingRect` Returns a tuple that contains the co-ordinates of the
:meth:`~wx.lib.colourchooser.canvas.Canvas.MakeNewBuffer`
:meth:`~wx.lib.colourchooser.canvas.Canvas.onPaint` Renders the off-screen buffer on-screen.
:meth:`~wx.lib.colourchooser.canvas.Canvas.onSize` Perform actual redraw to off-screen buffer only when the
:meth:`~wx.lib.colourchooser.canvas.Canvas.ReDraw` Explicitly tells the canvas to redraw it's contents.
:meth:`~wx.lib.colourchooser.canvas.Canvas.Refresh` Re-draws the buffer contents on-screen.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Canvas(wx.Window)
A canvas class for arbitrary drawing.
The Canvas class implements a window that allows for drawing
arbitrary graphics. It implements a double buffer scheme and
blits the off-screen buffer to the window during paint calls
by the windowing system for speed.
Some other methods for determining the canvas colour and size
are also provided.
.. method:: __init__(self, parent, id, pos=wx.DefaultPosition, style=wx.SIMPLE_BORDER, forceClientSize=None)
Creates a canvas instance and initializes the off-screen
buffer. Also sets the handler for rendering the canvas
automatically via size and paint calls from the windowing
system.
.. method:: Blit(self, dc)
Performs the blit of the buffer contents on-screen.
.. method:: DrawBuffer(self)
Actual drawing function for drawing into the off-screen
buffer. To be overrideen in the implementing class. Do nothing
by default.
.. method:: GetBoundingRect(self)
Returns a tuple that contains the co-ordinates of the
top-left and bottom-right corners of the canvas.
.. method:: MakeNewBuffer(self)
.. method:: onPaint(self, event)
Renders the off-screen buffer on-screen.
.. method:: onSize(self, event)
Perform actual redraw to off-screen buffer only when the
size of the canvas has changed. This saves a lot of computation
since the same image can be re-used, provided the canvas size
hasn't changed.
.. method:: ReDraw(self)
Explicitly tells the canvas to redraw it's contents.
.. method:: Refresh(self)
Re-draws the buffer contents on-screen.
|
