.. 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.svg" 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="Implements saving a buffer to plain text." alt="" coords="5,159,298,188"/> <area shape="rect" id="node2" href="wx.richtext.RichTextFileHandler.html" title="The base class for file handlers." alt="" coords="25,82,279,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="102,5,201,34"/> </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: str="Text", ext: str="txt", type:
                                RichTextFileType=RICHTEXT_TYPE_TEXT) -> None
       
   
   Implements saving a buffer to plain text.



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




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




      :rtype: `None`     








   .. 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 : RichTextBuffer, stream : InputStream)

      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 : RichTextBuffer, stream : OutputStream)

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


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




      :rtype: `bool`