IlvScriptLanguage Class Reference

Scripting class. More...

#include <ilviews/base/script.h>

List of all members.

Public Member Functions
virtual	~IlvScriptLanguage ()
	Destructor.
const IlSymbol *	getName () const
	Gets the name of this language.
Static Public Member Functions
static IlvScriptLanguage *	Get (const char *name)
	Gets a scripting language by name.
static IlvScriptLanguage *	Get (const IlSymbol *name)
	Gets a scripting language by name.
static IlvScriptLanguage *	GetDefault ()
	Gets the default scripting language.

---

Detailed Description

Scripting class.

Library: display

This class is the base class for all scripting languages that can be connected to Rogue Wave Views. It gives access to the global information relative to a given language. An instance of IlvScriptLanguage (also referred to as a scripting language) is unique in a given application. A scripting language must be associated with an identifier that will be used to make the script code persistent. This identifier is referred to as the name of the scripting language.

---

Constructor & Destructor Documentation

virtual IlvScriptLanguage::~IlvScriptLanguage

(

)

[virtual]

Destructor.

Releases the memory that the scripting language might have allocated (in particular, its associated contexts).

---

Member Function Documentation

static IlvScriptLanguage* IlvScriptLanguage::Get

(

const char *

name

)

[static]

Gets a scripting language by name.

Parameters:

name

A string that identifies a scripting language name.

Returns:

The (unique) instance of the scripting language whose symbol name is equal to name.

static IlvScriptLanguage* IlvScriptLanguage::Get

(

const IlSymbol *

name

)

[static]

Gets a scripting language by name.

Parameters:

name

A symbol that identifies a scripting language.

Returns:

The (unique) instance of the scripting language whose name is name.

static IlvScriptLanguage* IlvScriptLanguage::GetDefault

(

)

[static]

Gets the default scripting language.

This member function is useful when you know that there is a scripting language linked to your application, but you don't know its name.

Returns:

The (unique) instance to the default scripting language, or 0 if no scripting language is linked with the application.

const IlSymbol* IlvScriptLanguage::getName

(

)

const

Gets the name of this language.

Returns:

The name of this language.