Virtual class to act as an interface for all text codecs. More...
#include <vtkTextCodec.h>
Inheritance diagram for vtkTextCodec:
Collaboration diagram for vtkTextCodec:
Classes | |
| class | OutputIterator |
| a base class that any output iterators need to derive from to use the first signature of to_unicode. More... | |
Public Types | |
| typedef vtkObject | Superclass |
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... | |
| vtkTextCodec * | NewInstance () const |
| virtual bool | CanHandle (const char *NameString) |
| virtual bool | IsValid (istream &InputStream) |
| is the given sample valid for this codec? The stream will not be advanced. More... | |
| virtual const char * | Name () |
| The name this codec goes by - should match the string the factory will take to create it. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| The name this codec goes by - should match the string the factory will take to create it. 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 vtkTextCodec * | SafeDownCast (vtkObjectBase *o) |
| 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 |
| 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 &) |
| virtual void | ToUnicode (istream &InputStream, vtkTextCodec::OutputIterator &output)=0 |
| Iterate through the sequence represented by the stream assigning the result to the output iterator. More... | |
| vtkUnicodeString | ToUnicode (istream &inputStream) |
| convenience method to take data from the stream and put it into a vtkUnicodeString. More... | |
| virtual vtkUnicodeString::value_type | NextUnicode (istream &inputStream)=0 |
| 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. More... | |
| vtkTextCodec () | |
| Iterate through the sequence represented by the stream assigning the result to the output iterator. More... | |
| ~vtkTextCodec () override | |
| Iterate through the sequence represented by the stream assigning the result to the output iterator. More... | |
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
Virtual class to act as an interface for all text codecs.
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
- vtkTextCodecFactory
Definition at line 44 of file vtkTextCodec.h.
Member Typedef Documentation
| typedef vtkObject vtkTextCodec::Superclass |
Definition at line 47 of file vtkTextCodec.h.
Constructor & Destructor Documentation
|
protected |
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.
|
overrideprotected |
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.
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.
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
|
static |
|
protectedvirtual |
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
| vtkTextCodec* vtkTextCodec::NewInstance | ( | ) | const |
|
virtual |
The name this codec goes by - should match the string the factory will take to create it.
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
|
overridevirtual |
The name this codec goes by - should match the string the factory will take to create it.
Reimplemented from vtkObject.
Reimplemented in vtkUTF16TextCodec, and vtkUTF8TextCodec.
|
virtual |
Reimplemented in vtkASCIITextCodec, vtkUTF16TextCodec, and vtkUTF8TextCodec.
|
virtual |
is the given sample valid for this codec? The stream will not be advanced.
Reimplemented in vtkUTF16TextCodec, vtkASCIITextCodec, and vtkUTF8TextCodec.
|
pure 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.
Implemented in vtkUTF16TextCodec, vtkASCIITextCodec, and vtkUTF8TextCodec.
| vtkUnicodeString vtkTextCodec::ToUnicode | ( | istream & | inputStream | ) |
convenience method to take data from the stream and put it into a vtkUnicodeString.
|
pure 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.
Implemented in vtkUTF16TextCodec, vtkASCIITextCodec, and vtkUTF8TextCodec.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/IO/Core/vtkTextCodec.h
