The base class for file handlers.
Class Hierarchy¶Inheritance diagram for class
RichTextFileHandler:
Known Subclasses¶wx.richtext.RichTextHTMLHandler, wx.richtext.RichTextPlainTextHandler, wx.richtext.RichTextXMLHandler
Methods Summary¶Creates a file handler object.
Returns True if we handle this filename (if using files).
Returns True if we can load using this handler.
Returns True if we can save using this handler.
Override to load content from stream into buffer.
Override to save content to stream from buffer.
Returns the encoding to use when saving a file.
Returns the default extension to recognise.
Returns flags controlling how loading and saving is done.
Returns the name of the handler.
Returns the handler type.
Returns True if this handler should be visible to the user.
Loads the buffer from a stream.
Saves the buffer to a stream.
Sets the encoding to use when saving a file.
Sets the default extension to recognise.
Sets flags that change the behaviour of loading or saving.
Sets the name of the handler.
Sets the handler type.
Sets whether the handler should be visible to the user (via the applicationâs load and save dialogs).
Properties Summary¶ Class API¶Possible constructors:
RichTextFileHandler(name='', ext='', type=0) -> None
The base class for file handlers.
Creates a file handler object.
name (string)
ext (string)
type (int)
None
Returns True if we handle this filename (if using files).
By default, checks the extension.
filename (string)
bool
Returns True if we can load using this handler.
bool
Returns True if we can save using this handler.
bool
Override to load content from stream into buffer.
buffer (wx.richtext.RichTextBuffer)
stream (wx.InputStream)
bool
Override to save content to stream from buffer.
buffer (wx.richtext.RichTextBuffer)
stream (wx.OutputStream)
bool
Returns the encoding to use when saving a file.
If empty, a suitable encoding is chosen.
str
Returns the default extension to recognise.
str
Returns flags controlling how loading and saving is done.
int
Returns the name of the handler.
str
Returns the handler type.
int
Returns True if this handler should be visible to the user.
bool
LoadFile (self, buffer, stream)
Loads the buffer from a stream.
Not all handlers will implement file loading.
buffer (wx.richtext.RichTextBuffer)
stream (wx.InputStream)
bool
LoadFile (self, buffer, filename)
Loads the buffer from a file.
buffer (wx.richtext.RichTextBuffer)
filename (string)
bool
SaveFile (self, buffer, stream)
Saves the buffer to a stream.
Not all handlers will implement file saving.
buffer (wx.richtext.RichTextBuffer)
stream (wx.OutputStream)
bool
SaveFile (self, buffer, filename)
Saves the buffer to a file.
buffer (wx.richtext.RichTextBuffer)
filename (string)
bool
Sets the encoding to use when saving a file.
If empty, a suitable encoding is chosen.
encoding (string)
None
Sets the default extension to recognise.
ext (string)
None
Sets flags that change the behaviour of loading or saving.
See the documentation for each handler class to see what flags are relevant for each handler.
You call this function directly if you are using a file handler explicitly (without going through the text control or buffer LoadFile/SaveFile API). Or, you can call the control or bufferâs SetHandlerFlags function to set the flags that will be used for subsequent load and save operations.
flags (int)
None
Sets the name of the handler.
name (string)
None
Sets the handler type.
type (int)
None
Sets whether the handler should be visible to the user (via the applicationâs load and save dialogs).
visible (bool)
None
See GetEncoding and SetEncoding
See GetExtension and SetExtension
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4
