template class TclSubObject

sub object interface parent class

Inheritance:

Public Methods

	TclSubObject () empty constructor
virtual	~TclSubObject () empty destructor
typedef int	(TclSubObject::*SUBOPTION) (CLIENT *, int argc, char **argv) sub object commands prototype
static void	newSubOption (char *name, int (TclSubObject::*cmd)(CLIENT *, int argc, char **argv), const char *synopsis = 0, const char *description = 0) adds a new option to this command
int	exec (CLIENT *ptr, int argc, char **argv) executes command
virtual TclObjectKind*	getObjectKind (void) const returns main object object kind
virtual unsigned int	getRef (void) const returns main object reference

Protected Fields

static std::map CommandSubOption *, CStringCompare>

suboptions sub object commands list

static std::map CommandSubOption *, CStringCompare> suboptions

sub object commands list

TclSubObject()

empty constructor

virtual ~TclSubObject()

empty destructor

typedef int (TclSubObject::*SUBOPTION)(CLIENT *, int argc, char **argv)

sub object commands prototype

static void newSubOption(char *name, int (TclSubObject::*cmd)(CLIENT *, int argc, char **argv), const char *synopsis = 0, const char *description = 0)

adds a new option to this command

Parameters:

name - option name
cmd - command option callback method
synopsis - option synopsis
description - option description

int exec(CLIENT *ptr, int argc, char **argv)

executes command

Returns:

TCL_OK if command succesfully evaluated, TCL_ERROR otherwise

Parameters:

ptr - subobject to apply function on
argc - command options number
argv - command options

virtual TclObjectKind* getObjectKind(void) const

returns main object object kind

virtual unsigned int getRef(void) const

returns main object reference

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de