Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IlvScriptLanguage Class Referenceabstract

Scripting class. More...

#include <ilviews/base/script.h>

Public Member Functions

virtual ~IlvScriptLanguage ()
 Destructor. More...
 
const IlSymbolgetName () const
 Gets the name of this language. More...
 

Static Public Member Functions

static IlvScriptLanguageGet (const char *name)
 Gets a scripting language by name. More...
 
static IlvScriptLanguageGet (const IlSymbol *name)
 Gets a scripting language by name. More...
 
static IlvScriptLanguageGetDefault ()
 Gets the default scripting language. More...
 

Detailed Description

Scripting class.

Library: xviews or winviews or mviews (mutually exclusive)

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

◆ ~IlvScriptLanguage()

virtual IlvScriptLanguage::~IlvScriptLanguage ( )
virtual

Destructor.

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

Member Function Documentation

◆ Get() [1/2]

static IlvScriptLanguage* IlvScriptLanguage::Get ( const char *  name)
static

Gets a scripting language by name.

Parameters
nameA string that identifies a scripting language name.
Returns
The (unique) instance of the scripting language whose symbol name is equal to name.

◆ Get() [2/2]

static IlvScriptLanguage* IlvScriptLanguage::Get ( const IlSymbol name)
static

Gets a scripting language by name.

Parameters
nameA symbol that identifies a scripting language.
Returns
The (unique) instance of the scripting language whose name is name.

◆ GetDefault()

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.

◆ getName()

const IlSymbol* IlvScriptLanguage::getName ( ) const

Gets the name of this language.

Returns
The name of this language.