vtkKWArguments Class Reference

simple wrapper for icons More...

#include <vtkKWArguments.h>

List of all members.

Public Types

typedef int(* CallbackType )(const char *argument, const char *value, void *call_data)

typedef int(* ErrorCallbackType )(const char *argument, void *client_data)

enum VariableTypeEnum { NO_VARIABLE_TYPE = 0, INT_TYPE, DOUBLE_TYPE, STRING_TYPE }

enum ArgumentTypeEnum { NO_ARGUMENT, CONCAT_ARGUMENT, SPACE_ARGUMENT, EQUAL_ARGUMENT }

Public Member Functions

vtkTypeRevisionMacro (vtkKWArguments, vtkObject)

void PrintSelf (ostream &os, vtkIndent indent)

void Initialize (int argc, char *argv[])

int Parse ()

void AddCallbacks (CallbackStructure *callbacks)

void GetRemainingArguments (int *argc, char ***argv)

void Initialize ()

void AddArgument (const char *arg)

void AddCallback (const char *argument, ArgumentTypeEnum type, CallbackType callback, void *call_data, const char *help)

void AddCallback (const char *argument, ArgumentTypeEnum type, const char *help)

void AddHandler (const char *argument, ArgumentTypeEnum type, VariableTypeEnum vtype, void *variable, const char *help)

void AddHandler (const char *argument, ArgumentTypeEnum type, int *variable, const char *help)

void AddHandler (const char *argument, ArgumentTypeEnum type, double *variable, const char *help)

void AddHandler (const char *argument, ArgumentTypeEnum type, char **variable, const char *help)

void AddBooleanHandler (const char *argument, int *variable, const char *help)

void SetClientData (void *client_data)

void SetUnknownArgumentCallback (ErrorCallbackType callback)

virtual char * GetHelp ()

const char * GetHelp (const char *arg)

virtual void SetLineLength (unsigned int)

virtual unsigned int GetLineLength ()

int IsSpecified (const char *arg)

const char * GetValue (const char *arg)

Static Public Member Functions

vtkKWArguments * New ()

Protected Types

typedef vtkKWArgumentsInternal Internal

Protected Member Functions

vtkKWArguments ()

~vtkKWArguments ()

virtual void SetHelp (const char *)

void GenerateHelp ()

Protected Attributes

Internal * Internals

char * Help

unsigned int LineLength

Detailed Description

simple wrapper for icons

A simple icon wrapper. It can either be used with file icons.h to provide a unified interface for internal icons or a wrapper for custom icons. The icons are defined with width, height, pixel_size, and array of unsigned char values.

Definition at line 30 of file vtkKWArguments.h.

Member Typedef Documentation

typedef int(* vtkKWArguments::CallbackType)(const char* argument, const char* value, void* call_data)

Definition at line 58 of file vtkKWArguments.h.

typedef int(* vtkKWArguments::ErrorCallbackType)(const char* argument, void* client_data)

Definition at line 60 of file vtkKWArguments.h.

typedef vtkKWArgumentsInternal vtkKWArguments::Internal [protected]

Definition at line 155 of file vtkKWArguments.h.

Member Enumeration Documentation

enum vtkKWArguments::ArgumentTypeEnum

These are different argument types.
Enumeration values:

NO_ARGUMENT

CONCAT_ARGUMENT

SPACE_ARGUMENT

EQUAL_ARGUMENT

Definition at line 42 of file vtkKWArguments.h.

enum vtkKWArguments::VariableTypeEnum

Enumeration values:

NO_VARIABLE_TYPE

INT_TYPE

DOUBLE_TYPE

STRING_TYPE

Definition at line 50 of file vtkKWArguments.h.

Constructor & Destructor Documentation

vtkKWArguments::vtkKWArguments ( ) [protected]

vtkKWArguments::~vtkKWArguments ( ) [protected]

Member Function Documentation

vtkKWArguments* vtkKWArguments::New ( ) [static]

vtkKWArguments::vtkTypeRevisionMacro ( vtkKWArguments ,

vtkObject

)

void vtkKWArguments::PrintSelf ( ostream & os,

vtkIndent indent

)

void vtkKWArguments::Initialize ( int argc,

char * argv[]

)

Initialize internal data structures. This should be called before parsing.

void vtkKWArguments::Initialize ( )

Initialize internal data structure and pass arguments one by one. This is convinience method for use from scripting languages where argc and argv are not available.

void vtkKWArguments::AddArgument ( const char * arg )

Initialize internal data structure and pass arguments one by one. This is convinience method for use from scripting languages where argc and argv are not available.

int vtkKWArguments::Parse ( )

This method will parse arguments and call apropriate methods.

void vtkKWArguments::AddCallback ( const char * argument,

ArgumentTypeEnum type,

CallbackType callback,

void * call_data,

const char * help

)

This method will add a callback for a specific argument. The arguments to it are argument, argument type, callback method, and call data. The argument help specifies the help string used with this option. The callback and call_data can be skipped.

void vtkKWArguments::AddCallback ( const char * argument,

ArgumentTypeEnum type,

const char * help

) [inline]

This method will add a callback for a specific argument. The arguments to it are argument, argument type, callback method, and call data. The argument help specifies the help string used with this option. The callback and call_data can be skipped.
Definition at line 97 of file vtkKWArguments.h.

void vtkKWArguments::AddHandler ( const char * argument,

ArgumentTypeEnum type,

VariableTypeEnum vtype,

void * variable,

const char * help

)

Add handler for argument which is going to set the variable to the specified value.

void vtkKWArguments::AddHandler ( const char * argument,

ArgumentTypeEnum type,

int * variable,

const char * help

)

Add handler for argument which is going to set the variable to the specified value.

void vtkKWArguments::AddHandler ( const char * argument,

ArgumentTypeEnum type,

double * variable,

const char * help

)

Add handler for argument which is going to set the variable to the specified value.

void vtkKWArguments::AddHandler ( const char * argument,

ArgumentTypeEnum type,

char ** variable,

const char * help

)

Add handler for argument which is going to set the variable to the specified value.

void vtkKWArguments::AddBooleanHandler ( const char * argument,

int * variable,

const char * help

)

Add handler for argument which is going to set the variable to the specified value.

void vtkKWArguments::AddCallbacks ( CallbackStructure * callbacks )

This method registers callbacks for argument types from array of structures. It stops when an entry has all zeros.

void vtkKWArguments::SetClientData ( void * client_data )

Set the callbacks for error handling.

void vtkKWArguments::SetUnknownArgumentCallback ( ErrorCallbackType callback )

Set the callbacks for error handling.

void vtkKWArguments::GetRemainingArguments ( int * argc,

char *** argv

)

Get remaining arguments. It allocates space for argv, so you have to call delete[] on it.

virtual char* vtkKWArguments::GetHelp ( ) [virtual]

Return string containing help. If the argument is specified, only return help for that argument.

const char* vtkKWArguments::GetHelp ( const char * arg )

Return string containing help. If the argument is specified, only return help for that argument.

virtual void vtkKWArguments::SetLineLength ( unsigned int ) [virtual]

Get / Set the line length. Default length is 80.

virtual unsigned int vtkKWArguments::GetLineLength ( ) [virtual]

Get / Set the line length. Default length is 80.

int vtkKWArguments::IsSpecified ( const char * arg )

This are methods for map interface. After calling ->Parse(), the program can ask the map for its entries.

const char* vtkKWArguments::GetValue ( const char * arg )

This are methods for map interface. After calling ->Parse(), the program can ask the map for its entries.

virtual void vtkKWArguments::SetHelp ( const char * ) [protected, virtual]

void vtkKWArguments::GenerateHelp ( ) [protected]

Member Data Documentation

Internal* vtkKWArguments::Internals [protected]

Definition at line 157 of file vtkKWArguments.h.

char* vtkKWArguments::Help [protected]

Definition at line 158 of file vtkKWArguments.h.

unsigned int vtkKWArguments::LineLength [protected]

Definition at line 160 of file vtkKWArguments.h.

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

Common/KWCommon/vtkKWArguments.h

Generated on Tue May 30 12:35:12 2006 for ParaView by

1.3.5


Public Types
typedef int(*	CallbackType )(const char argument, const char value, void *call_data)
typedef int(*	ErrorCallbackType )(const char argument, void client_data)
enum	VariableTypeEnum { NO_VARIABLE_TYPE = 0, INT_TYPE, DOUBLE_TYPE, STRING_TYPE }

enum	ArgumentTypeEnum { NO_ARGUMENT, CONCAT_ARGUMENT, SPACE_ARGUMENT, EQUAL_ARGUMENT }
Public Member Functions
	vtkTypeRevisionMacro (vtkKWArguments, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize (int argc, char *argv[])
int	Parse ()
void	AddCallbacks (CallbackStructure *callbacks)
void	GetRemainingArguments (int argc, char **argv)

void	Initialize ()
void	AddArgument (const char *arg)

void	AddCallback (const char argument, ArgumentTypeEnum type, CallbackType callback, void call_data, const char *help)
void	AddCallback (const char argument, ArgumentTypeEnum type, const char help)

void	AddHandler (const char argument, ArgumentTypeEnum type, VariableTypeEnum vtype, void variable, const char *help)
void	AddHandler (const char argument, ArgumentTypeEnum type, int variable, const char *help)
void	AddHandler (const char argument, ArgumentTypeEnum type, double variable, const char *help)
void	AddHandler (const char argument, ArgumentTypeEnum type, char variable, const char help)
void	AddBooleanHandler (const char argument, int variable, const char *help)

void	SetClientData (void *client_data)
void	SetUnknownArgumentCallback (ErrorCallbackType callback)

virtual char *	GetHelp ()
const char *	GetHelp (const char *arg)

virtual void	SetLineLength (unsigned int)
virtual unsigned int	GetLineLength ()

int	IsSpecified (const char *arg)
const char *	GetValue (const char *arg)
Static Public Member Functions
vtkKWArguments *	New ()
Protected Types
typedef vtkKWArgumentsInternal	Internal
Protected Member Functions
	vtkKWArguments ()
	~vtkKWArguments ()
virtual void	SetHelp (const char *)
void	GenerateHelp ()
Protected Attributes
Internal *	Internals
char *	Help
unsigned int	LineLength