1.1 Context of Tcl

1.2 Structure of this manual

2 Quick Overview

2.1 Procedural versus Object-Oriented

2.2 Classes and Objects

	class Circle {
		#
		# Constructor and Destructor
		#

		Circle {x y r} {
			set x_      $x
			set y_      $y
			set radius_ $r
		}

		~Circle {} {
			Undraw
		}

		#
		# Operations
		#
	
		proc Draw {} {
		}

		proc Undraw {} {
		}

		#
		# Data Members
		#

		variable scalar x_
		variable scalar y_
		variable scalar radius_
	}

	Circle circle1 10 20 5

	circle1 draw

	circle1 delete

	delete circle1

2.3 Classes as types

	class TwoCircle {
		# 
		# Operations
		#

		proc draw {} {
			circle1_ draw
			circle2_ draw
		}

		variable Circle circle1_
		variable Circle circle2_
	}

2.4 Implicit object naming

	set object [new Circle 10 20 5]

	$object draw

	set object [new Circle 10 20 5]
	$object draw
	set object [new Circle 20 30 8]		;# Memory leak: First object 
						;# cannot be referenced 
						;# anymore !

2.5 Inheritance

	class Shape {
		proc move {deltax deltay} {
		}

		proc rotate {x y degrees} {
		}
	}

	class DrawingEditor {
		variable scalar shapes 	;# List of shape object names
	}

	class Circle : Shape {
	}

2.6 Virtual Functions

	class Shape {
		virtual proc draw {} {
		}
	}

	class Circle : Shape {
		proc draw {} {
			# Drawing a circle
		}
	}

	class Rectangle : Shape {
		proc draw {} {
			# Drawing a rectangle
		}
	}

3 Classes

3.1 Introduction

	class Minimal {}

	class Example {
		....
	}

	Example ex1
	Example ex2

3.2 Variable Declaration

	class Example {
		variable scalar name		;# build-in type
		variable array  properties	;# build-in type
		variable Date   date
		variable Time	time
	}

	class Example {
		variable scalar this		;# Error
	}

3.3 Procedure Definition

	class Example {
		proc setProperty {key value} {
			set property_($key) $value
		}

		proc display {} {
			puts "Object '$this' has the following properties:"
			foreach key [array names property_] {
				puts "$key -> $property_($key)"
			}
		}

		variable array property_
	}

	ex1 setProperty shoesize 42
	ex1 display

	class Example {
		proc function-1 {} {
		}

		proc function-2 {} {
			function-1		;# Ok (Tclpp 2.0 onwards)
		}

		proc function-3 {} {
			$this function-1	;# Still Ok
		}
	}

3.4 Construction and Destruction

	Example ex1			;# User provides name
	set ex2 [new Example]		;# System provides name

	ex1 delete
	$ex2 delete

	delete ex1
	delete $ex2

3.4.1 Constructors

	class Example {
		proc Example {aName} {
			set name $aName
		}
		variable scalar name
	}
	Example ex1 "An Example"

	class Date {
		proc Date {day month year} {
		}
	}

	class Schedule {
		variable Date date	;# Error, will invoke the
					;# constructor of Date without
					;# any parameters upon creation
	}

3.4.2 Destructors

	class Appointment {
		proc ~Appointment {} {
			puts "Appointment deleted"
		}
	}
	class Schedule {
		variable Appointment appointment
	}
	Schedule s1
	s1 delete	;# Calls destructor of the class variable
			;# Schedule::appointment as well		

4 Inheritance

4.1 Introduction

	class Person {
		proc setName    {name}    { .... }
		proc getName    {}        { .... }
		proc setAddress {address} { .... }
		proc getAddress {}        { .... }
		
		variable scalar name
		variable scalar address
	}

	class Employee : Person {
		proc setFunction {function} { .... }
		proc getFunction {}         { .... }
		proc setSalary   {amount}   { .... }
		proc getSalary   {}         { .... }

		variable scalar function
		variable scalar salary
	}

4.1.1 Construction and Destruction

4.2 Virtual Functions

	class Shape {
		virtual proc Draw {} {
			error "Cannot draw a shapeless form"
		}
	}

	class Rectangle : Draw {
		proc Draw {} {
			# Procedure to draw a rectangle
		}
	}

	class Circle : Draw {
		proc Draw {} {
			# Procedure to draw a cirle
		}
	}

	class Manager {
		proc Draw {} {
			foreach shape $shapes {
				$shape Draw
			}
		}
		variable scalar shapes
	}

4.3 Multiple Inheritance

	class Animal {
	}

	class Male : Animal {
	}

	class Female : Animal {
	}

	class Hermaphrodite : Male Female {
	}

5 Information

5.1 Version Information

• tclpp_version returns the major and minor version number. For example 2.0 represents major release 2 and minor release 0.
• tclpp_patchLevel returns the complete version number, including the patch level. For example 2.0b2 represents the second beta release of version 2.0.

5.2 Class Information

5.2.1 Defined classes

	classinfo classes ?pattern?

5.2.2 Class heritage

	classinfo heritage class

	class Base1 {}
	class Base2 : Base1 {}
	class Derived : Base2 {}

5.2.3 Class Variables

	classinfo variables class

	class Base {
	        variable scalar base_member
        }
	class Derived : Base {
		variable scalar derived_member
	}

	% classinfo variables Base
	{{this scalar} {base_member scalar}}
	% classinfo variables Derived
	{{this scalar} {derived_member scalar}}

5.2.4 Class Methods

	classinfo methods class

5.3 Run-Time Type Information

5.3.1 Class of an Object

	objectinfo object isA 

	class Base { .... }
	class Derived : Base { .... }
	Derived d

	objectinfo d isA	;# Returns '::Derived'

5.3.2 Object is a class

	objectinfo object isKindOf class 

	class Base { .... }
	class Derived : Base { .... }
	Base b
	Derived d

	objectinfo b isKindOf Base	;# Returns true
	objectinfo b isKindOf Derived	;# Returns false
	objectinfo d isKindOf Derived	;# Returns true
	objectinfo d isKindOf Base	;# Returns true

6 Scoping

6.1 Basic Scoping

6.2 Using Namespaces

7 Reference Manual

8 Compatibility