VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkTextCodecFactory Class Reference

maintain a list of text codecs and return instances More...

#include <vtkTextCodecFactory.h>

Inheritance diagram for vtkTextCodecFactory:
[legend]
Collaboration diagram for vtkTextCodecFactory:
[legend]

List of all members.

Public Types

typedef vtkObject Superclass
typedef vtkTextCodec *(* CreateFunction )()
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkTextCodecFactorySafeDownCast (vtkObject *o)
static vtkTextCodecFactoryNew ()
static vtkTextCodecCodecForName (const char *CodecName)
static vtkTextCodecCodecToHandle (istream &InputStream)
static void Initialize ()
static void RegisterCreateCallback (CreateFunction callback)
static void UnRegisterCreateCallback (CreateFunction callback)
static void UnRegisterAllCreateCallbacks ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkTextCodecFactory ()
 ~vtkTextCodecFactory ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

maintain a list of text codecs and return instances

A single class to hold registered codecs and return instances of them based on either a decriptive name (UTF16 or latin-1) or by asking who can handle a given vtkstd::vector<unsigned char>

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:
vtkTextCodec

Definition at line 45 of file vtkTextCodecFactory.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 48 of file vtkTextCodecFactory.h.

typedef vtkTextCodec*(* vtkTextCodecFactory::CreateFunction)()

Type for Creation callback.

Definition at line 53 of file vtkTextCodecFactory.h.


Constructor & Destructor Documentation

vtkTextCodecFactory::vtkTextCodecFactory ( )
protected
vtkTextCodecFactory::~vtkTextCodecFactory ( )
protected

Member Function Documentation

virtual const char* vtkTextCodecFactory::GetClassName ( )
virtual

Reimplemented from vtkObject.

static int vtkTextCodecFactory::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 vtkObject.

virtual int vtkTextCodecFactory::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 vtkObject.

static vtkTextCodecFactory* vtkTextCodecFactory::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkObject.

static vtkTextCodecFactory* vtkTextCodecFactory::New ( )
static

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

Reimplemented from vtkObject.

void vtkTextCodecFactory::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static void vtkTextCodecFactory::RegisterCreateCallback ( CreateFunction  callback)
static

Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkTextCodecFactory to handle different protocols. The registered callbacks are tried in the order they are registered.

static void vtkTextCodecFactory::UnRegisterCreateCallback ( CreateFunction  callback)
static

Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkTextCodecFactory to handle different protocols. The registered callbacks are tried in the order they are registered.

static void vtkTextCodecFactory::UnRegisterAllCreateCallbacks ( )
static

Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkTextCodecFactory to handle different protocols. The registered callbacks are tried in the order they are registered.

static vtkTextCodec* vtkTextCodecFactory::CodecForName ( const char *  CodecName)
static

Given a codec/storage name try to find one of our registered codecs that can handle it. This is non-deterministic, very messy and should not be your first thing to try. The registered callbacks are tried in the order they are registered.

static vtkTextCodec* vtkTextCodecFactory::CodecToHandle ( istream &  InputStream)
static

Given a snippet of the stored data name try to find one of our registered codecs that can handle transforming it into unicode. The registered callbacks are tried in the order they are registered.

static void vtkTextCodecFactory::Initialize ( )
static

Initialize core text codecs - needed for the static compilation case.


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