vtkUTF8TextCodec Class Reference

#include <vtkUTF8TextCodec.h>

Inheritance diagram for vtkUTF8TextCodec:

Inheritance graph
[legend]
Collaboration diagram for vtkUTF8TextCodec:

Collaboration graph
[legend]

List of all members.


Detailed Description

Class to read/write UTF-8 text.

A virtual class interface for codecs that readers/writers can rely on

Thanks:
Thanks to Tim Shed from Sandia National Laboratories for his work on the concepts and to Marcus Hanwell and Jeff Baumes of Kitware for keeping me out of the weeds
See also:
vtkUTF8TextCodecFactory

Definition at line 42 of file vtkUTF8TextCodec.h.


Public Types

typedef vtkTextCodec Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual bool IsValid (istream &InputStream)
virtual
vtkUnicodeString::value_type 
NextUnicode (istream &inputStream)
virtual const char * Name ()
virtual bool CanHandle (const char *testStr)
virtual void ToUnicode (istream &InputStream, vtkTextCodec::OutputIterator &output)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkUTF8TextCodecSafeDownCast (vtkObject *o)
static vtkUTF8TextCodecNew ()

Protected Member Functions

 vtkUTF8TextCodec ()
 ~vtkUTF8TextCodec ()

Member Typedef Documentation

Reimplemented from vtkTextCodec.

Definition at line 45 of file vtkUTF8TextCodec.h.


Constructor & Destructor Documentation

vtkUTF8TextCodec::vtkUTF8TextCodec (  )  [protected]

vtkUTF8TextCodec::~vtkUTF8TextCodec (  )  [protected]


Member Function Documentation

virtual const char* vtkUTF8TextCodec::GetClassName (  )  [virtual]

Reimplemented from vtkTextCodec.

static int vtkUTF8TextCodec::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTextCodec.

virtual int vtkUTF8TextCodec::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTextCodec.

static vtkUTF8TextCodec* vtkUTF8TextCodec::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkTextCodec.

static vtkUTF8TextCodec* vtkUTF8TextCodec::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

void vtkUTF8TextCodec::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

The name this codec goes by - should match the string the factory will take to create it

Reimplemented from vtkTextCodec.

virtual const char* vtkUTF8TextCodec::Name (  )  [inline, virtual]

The name this codec goes by - should match the string the factory will take to create it

Reimplemented from vtkTextCodec.

Definition at line 52 of file vtkUTF8TextCodec.h.

virtual bool vtkUTF8TextCodec::CanHandle ( const char *  testStr  )  [virtual]

The name this codec goes by - should match the string the factory will take to create it

Reimplemented from vtkTextCodec.

virtual bool vtkUTF8TextCodec::IsValid ( istream &  InputStream  )  [virtual]

is the given sample valid for this codec?

Reimplemented from vtkTextCodec.

virtual void vtkUTF8TextCodec::ToUnicode ( istream &  InputStream,
vtkTextCodec::OutputIterator output 
) [virtual]

Iterate through the sequence represented by the stream assigning the result to the output iterator. The stream will be advanced to its end so subsequent use would need to reset it.

Implements vtkTextCodec.

virtual vtkUnicodeString::value_type vtkUTF8TextCodec::NextUnicode ( istream &  inputStream  )  [virtual]

Return the next code point from the sequence represented by the stream advancing the stream through however many places needed to assemble that code point

Implements vtkTextCodec.


The documentation for this class was generated from the following file:

Generated on Wed Aug 24 12:17:01 2011 for VTK by  doxygen 1.5.6