maintain a list of text codecs and return instances More...
#include <vtkTextCodecFactory.h>
Inheritance diagram for vtkTextCodecFactory:
Collaboration diagram for vtkTextCodecFactory:
Public Types | |
| typedef vtkObject | Superclass |
| typedef vtkTextCodec *(* | CreateFunction) () |
| Type for Creation callback. More... | |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkTextCodecFactory * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkTextCodecFactory * | SafeDownCast (vtkObjectBase *o) |
| static vtkTextCodecFactory * | New () |
| static vtkTextCodec * | CodecForName (const char *CodecName) |
| Given a codec/storage name try to find one of our registered codecs that can handle it. More... | |
| static vtkTextCodec * | CodecToHandle (istream &InputStream) |
| Given a snippet of the stored data name try to find one of our registered codecs that can handle transforming it into unicode. More... | |
| static void | Initialize () |
| Initialize core text codecs - needed for the static compilation case. More... | |
| static void | RegisterCreateCallback (CreateFunction callback) |
| Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkTextCodecFactory to handle different protocols. More... | |
| static void | UnRegisterCreateCallback (CreateFunction callback) |
| Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkTextCodecFactory to handle different protocols. More... | |
| static void | UnRegisterAllCreateCallbacks () |
| Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkTextCodecFactory to handle different protocols. More... | |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkTextCodecFactory () | |
| ~vtkTextCodecFactory () override | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | 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 std::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 47 of file vtkTextCodecFactory.h.
Member Typedef Documentation
Definition at line 50 of file vtkTextCodecFactory.h.
| typedef vtkTextCodec*(* vtkTextCodecFactory::CreateFunction) () |
Type for Creation callback.
Definition at line 57 of file vtkTextCodecFactory.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
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 vtkObjectBase.
|
static |
|
protectedvirtual |
| vtkTextCodecFactory* vtkTextCodecFactory::NewInstance | ( | ) | const |
|
static |
|
overridevirtual |
|
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 |
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 |
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 |
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 |
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 |
Initialize core text codecs - needed for the static compilation case.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/IO/Core/vtkTextCodecFactory.h
