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
|
.. 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
.. _wx.html.HtmlFilter:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlFilter**
==========================================================================================================================================
This class is the parent class of input filters for :ref:`wx.html.HtmlWindow`.
It allows you to read and display files of different file formats.
.. seealso:: :ref:`Input Filters <input filters>`
|
|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>HtmlFilter</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.html.HtmlFilter_inheritance.png" alt="Inheritance diagram of HtmlFilter" 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.html.HtmlFilter.html" title="wx.html.HtmlFilter" alt="" coords="4,83,139,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="31,5,112,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlFilter.__init__` Constructor.
:meth:`~wx.html.HtmlFilter.CanRead` Returns ``True`` if this filter is capable of reading file `file`.
:meth:`~wx.html.HtmlFilter.ReadFile` Reads the file and returns string with HTML document.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlFilter(Object)
**Possible constructors**::
HtmlFilter()
This class is the parent class of input filters for HtmlWindow.
.. method:: __init__(self)
Constructor.
.. method:: CanRead(self, file)
Returns ``True`` if this filter is capable of reading file `file`.
Example: ::
def CanRead(file):
# file is a wx.FSFile in this case...
return (file.GetMimeType() == "application/x-ugh")
:param `file`:
:type `file`: wx.FSFile
:rtype: `bool`
.. method:: ReadFile(self, file)
Reads the file and returns string with HTML document.
Example: ::
def ReadFile(file):
# file is a wx.FSFile in this case...
return "<html><body><img src=\"" + file.GetLocation() + \
"\"></body></html>"
:param `file`:
:type `file`: wx.FSFile
:rtype: `string`
|
