vtkStringList Class Reference

Manages allocation and freeing for a string list. More...

#include <vtkStringList.h>

Inheritance diagram for vtkStringList:

Collaboration diagram for vtkStringList:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	AddFormattedString (const char *EventString,...)
	Add a command and format it any way you like. More...
void	RemoveAllItems ()
	Initialize to empty. More...
void	SetString (int idx, const char *str)
	Random access. More...
int	GetLength ()
	Get the length of the list. More...
int	GetIndex (const char *str)
	Get the index of a string. More...
const char *	GetString (int idx)
	Get a command from its index. More...
int	GetNumberOfStrings ()
	Returns the number of strings. More...
void	AddString (const char *str)
	Add a simple string. More...
void	AddUniqueString (const char *str)
	Add a simple string. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (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 *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (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 *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
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)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkStringList *	New ()
static int	IsTypeOf (const char *type)
static vtkStringList *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkStringList ()
	~vtkStringList () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
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

Manages allocation and freeing for a string list.

A vtkStringList holds a list of strings. We might be able to replace it in the future.

Definition at line 18 of file vtkStringList.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkStringList::Superclass

Definition at line 22 of file vtkStringList.h.

Constructor & Destructor Documentation

vtkStringList()

vtkStringList::vtkStringList ( )

protected

~vtkStringList()

vtkStringList::~vtkStringList ( )

overrideprotected

Member Function Documentation

New()

static vtkStringList* vtkStringList::New ( )

static

GetClassName()

virtual const char* vtkStringList::GetClassName ( )

virtual

IsTypeOf()

static int vtkStringList::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkStringList::IsA ( const char *  type )

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

void vtkStringList::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Reimplemented from vtkObject.

AddString()

void vtkStringList::AddString

(

const char *

str

)

Add a simple string.

AddUniqueString()

void vtkStringList::AddUniqueString

(

const char *

str

)

Add a simple string.

AddFormattedString()

void vtkStringList::AddFormattedString	(	const char *	EventString,
			...
	)

Add a command and format it any way you like.

RemoveAllItems()

void vtkStringList::RemoveAllItems

(

)

Initialize to empty.

SetString()

void vtkStringList::SetString	(	int	idx,
		const char *	str
	)

Random access.

GetLength()

int vtkStringList::GetLength ( )

inline

Get the length of the list.

Definition at line 51 of file vtkStringList.h.

GetIndex()

int vtkStringList::GetIndex

(

const char *

str

)

Get the index of a string.

GetString()

const char* vtkStringList::GetString

(

int

idx

)

Get a command from its index.

GetNumberOfStrings()

int vtkStringList::GetNumberOfStrings

(

)

Returns the number of strings.

---

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

• /builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkStringList.h