File: wx.richtext.RichTextPlainTextHandler.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 (177 lines) | stat: -rw-r--r-- 4,544 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
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
.. 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.richtext.RichTextPlainTextHandler:

==========================================================================================================================================
|phoenix_title|  **wx.richtext.RichTextPlainTextHandler**
==========================================================================================================================================

Implements saving a buffer to plain text.          





         



.. seealso:: :ref:`wx.richtext.RichTextFileHandler`, :ref:`wx.richtext.RichTextBuffer`, :ref:`wx.richtext.RichTextCtrl`    







|

|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>RichTextPlainTextHandler</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.richtext.RichTextPlainTextHandler_inheritance.png" alt="Inheritance diagram of RichTextPlainTextHandler" 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.richtext.RichTextPlainTextHandler.html" title="wx.richtext.RichTextPlainTextHandler" alt="" coords="5,160,269,189"/> <area shape="rect" id="node2" href="wx.richtext.RichTextFileHandler.html" title="wx.richtext.RichTextFileHandler" alt="" coords="24,83,251,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="94,5,181,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextPlainTextHandler.__init__`                           
:meth:`~wx.richtext.RichTextPlainTextHandler.CanLoad`                            Returns ``True`` if we can load using this handler.
:meth:`~wx.richtext.RichTextPlainTextHandler.CanSave`                            Returns ``True`` if we can save using this handler.
:meth:`~wx.richtext.RichTextPlainTextHandler.DoLoadFile`                         Override to load content from `stream`  into `buffer`.
:meth:`~wx.richtext.RichTextPlainTextHandler.DoSaveFile`                         Override to save content to `stream`  from `buffer`.
================================================================================ ================================================================================


|


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


.. class:: wx.richtext.RichTextPlainTextHandler(RichTextFileHandler)

   **Possible constructors**::

       RichTextPlainTextHandler(name="Text", ext="txt",
                                type=RICHTEXT_TYPE_TEXT)
       
   
   Implements saving a buffer to plain text.



   .. method:: __init__(self, name="Text", ext="txt", type=RICHTEXT_TYPE_TEXT)




      :param `name`: 
      :type `name`: string
      :param `ext`: 
      :type `ext`: string
      :param `type`: 
      :type `type`: wx.richtext.RichTextFileType







   .. method:: CanLoad(self)

      Returns ``True`` if we can load using this handler.                  

      :rtype: `bool`








   .. method:: CanSave(self)

      Returns ``True`` if we can save using this handler.                  

      :rtype: `bool`








   .. method:: DoLoadFile(self, buffer, stream)

      Override to load content from `stream`  into `buffer`.                  


      :param `buffer`: 
      :type `buffer`: wx.richtext.RichTextBuffer
      :param `stream`: 
      :type `stream`: wx.InputStream




      :rtype: `bool`








   .. method:: DoSaveFile(self, buffer, stream)

      Override to save content to `stream`  from `buffer`.                  


      :param `buffer`: 
      :type `buffer`: wx.richtext.RichTextBuffer
      :param `stream`: 
      :type `stream`: wx.OutputStream




      :rtype: `bool`