Version: 3.0.4
wxRichTextPlainTextHandler Class Reference

#include <wx/richtext/richtextbuffer.h>

+ Inheritance diagram for wxRichTextPlainTextHandler:

Detailed Description

Implements saving a buffer to plain text.

Library:  wxRichText
Category:  Rich Text
See also
wxRichTextFileHandler, wxRichTextBuffer, wxRichTextCtrl

Public Member Functions

 wxRichTextPlainTextHandler (const wxString &name="Text", const wxString &ext="txt", wxRichTextFileType type=wxRICHTEXT_TYPE_TEXT)
 
virtual bool CanSave () const
 Returns true if we can save using this handler. More...
 
virtual bool CanLoad () const
 Returns true if we can load using this handler. More...
 
- Public Member Functions inherited from wxRichTextFileHandler
 wxRichTextFileHandler (const wxString &name=wxEmptyString, const wxString &ext=wxEmptyString, int type=0)
 Creates a file handler object. More...
 
bool LoadFile (wxRichTextBuffer *buffer, wxInputStream &stream)
 Loads the buffer from a stream. More...
 
bool SaveFile (wxRichTextBuffer *buffer, wxOutputStream &stream)
 Saves the buffer to a stream. More...
 
virtual bool LoadFile (wxRichTextBuffer *buffer, const wxString &filename)
 Loads the buffer from a file. More...
 
virtual bool SaveFile (wxRichTextBuffer *buffer, const wxString &filename)
 Saves the buffer to a file. More...
 
virtual bool CanHandle (const wxString &filename) const
 Returns true if we handle this filename (if using files). More...
 
virtual bool IsVisible () const
 Returns true if this handler should be visible to the user. More...
 
virtual void SetVisible (bool visible)
 Sets whether the handler should be visible to the user (via the application's load and save dialogs). More...
 
void SetName (const wxString &name)
 Sets the name of the handler. More...
 
wxString GetName () const
 Returns the name of the handler. More...
 
void SetExtension (const wxString &ext)
 Sets the default extension to recognise. More...
 
wxString GetExtension () const
 Returns the default extension to recognise. More...
 
void SetType (int type)
 Sets the handler type. More...
 
int GetType () const
 Returns the handler type. More...
 
void SetFlags (int flags)
 Sets flags that change the behaviour of loading or saving. More...
 
int GetFlags () const
 Returns flags controlling how loading and saving is done. More...
 
void SetEncoding (const wxString &encoding)
 Sets the encoding to use when saving a file. More...
 
const wxStringGetEncoding () const
 Returns the encoding to use when saving a file. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Protected Member Functions

virtual bool DoLoadFile (wxRichTextBuffer *buffer, wxInputStream &stream)
 Override to load content from stream into buffer. More...
 
virtual bool DoSaveFile (wxRichTextBuffer *buffer, wxOutputStream &stream)
 Override to save content to stream from buffer. More...
 
- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 

Additional Inherited Members

- Protected Attributes inherited from wxRichTextFileHandler
wxString m_name
 
wxString m_encoding
 
wxString m_extension
 
int m_type
 
int m_flags
 
bool m_visible
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxRichTextPlainTextHandler::wxRichTextPlainTextHandler ( const wxString name = "Text",
const wxString ext = "txt",
wxRichTextFileType  type = wxRICHTEXT_TYPE_TEXT 
)
inline

Member Function Documentation

virtual bool wxRichTextPlainTextHandler::CanLoad ( ) const
inlinevirtual

Returns true if we can load using this handler.

Reimplemented from wxRichTextFileHandler.

virtual bool wxRichTextPlainTextHandler::CanSave ( ) const
inlinevirtual

Returns true if we can save using this handler.

Reimplemented from wxRichTextFileHandler.

virtual bool wxRichTextPlainTextHandler::DoLoadFile ( wxRichTextBuffer buffer,
wxInputStream stream 
)
protectedvirtual

Override to load content from stream into buffer.

Implements wxRichTextFileHandler.

virtual bool wxRichTextPlainTextHandler::DoSaveFile ( wxRichTextBuffer buffer,
wxOutputStream stream 
)
protectedvirtual

Override to save content to stream from buffer.

Implements wxRichTextFileHandler.