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
|
.. 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.embeddedimage
.. highlight:: python
.. _wx.lib.embeddedimage.PyEmbeddedImage:
==========================================================================================================================================
|phoenix_title| **wx.lib.embeddedimage.PyEmbeddedImage**
==========================================================================================================================================
PyEmbeddedImage is primarily intended to be used by code generated
by img2py as a means of embedding image data in a python module so
the image can be used at runtime without needing to access the
image from an image file. This makes distributing icons and such
that an application uses simpler since tools like py2exe will
automatically bundle modules that are imported, and the
application doesn't have to worry about how to locate the image
files on the user's filesystem.
The class can also be used for image data that may be acquired
from some other source at runtime, such as over the network or
from a database. In this case pass ``False`` for isBase64 (unless the
data actually is base64 encoded.) Any image type that
wx.Image can handle should be okay.
|
|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>PyEmbeddedImage</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.embeddedimage.PyEmbeddedImage_inheritance.png" alt="Inheritance diagram of PyEmbeddedImage" 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.lib.embeddedimage.PyEmbeddedImage.html" title="wx.lib.embeddedimage.PyEmbeddedImage" alt="" coords="5,5,301,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.embeddedimage.PyEmbeddedImage.__init__`
:meth:`~wx.lib.embeddedimage.PyEmbeddedImage.GetBitmap`
:meth:`~wx.lib.embeddedimage.PyEmbeddedImage.GetData`
:meth:`~wx.lib.embeddedimage.PyEmbeddedImage.GetIcon`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.lib.embeddedimage.PyEmbeddedImage.Bitmap`
:attr:`~wx.lib.embeddedimage.PyEmbeddedImage.Data`
:attr:`~wx.lib.embeddedimage.PyEmbeddedImage.Icon`
:attr:`~wx.lib.embeddedimage.PyEmbeddedImage.Image`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: PyEmbeddedImage(object)
PyEmbeddedImage is primarily intended to be used by code generated
by img2py as a means of embedding image data in a python module so
the image can be used at runtime without needing to access the
image from an image file. This makes distributing icons and such
that an application uses simpler since tools like py2exe will
automatically bundle modules that are imported, and the
application doesn't have to worry about how to locate the image
files on the user's filesystem.
The class can also be used for image data that may be acquired
from some other source at runtime, such as over the network or
from a database. In this case pass ``False`` for isBase64 (unless the
data actually is base64 encoded.) Any image type that
wx.Image can handle should be okay.
.. method:: __init__(self, data, isBase64=True)
.. method:: GetBitmap(self)
.. method:: GetData(self)
.. method:: GetIcon(self)
.. attribute:: Bitmap
See :meth:`~PyEmbeddedImage.GetBitmap`
.. attribute:: Data
See :meth:`~PyEmbeddedImage.GetData`
.. attribute:: Icon
See :meth:`~PyEmbeddedImage.GetIcon`
.. attribute:: Image
See :meth:`~PyEmbeddedImage.GetImage`
|
