v8::Template Class Reference

The superclass of object and function templates. More...

#include <v8.h>

Inheritance diagram for v8::Template:

Collaboration diagram for v8::Template:

Public Member Functions
void	Set (Handle< Name > name, Handle< Data > value, PropertyAttribute attributes=None)
	Adds a property to each instance created by this template. More...
void	Set (Isolate *isolate, const char *name, Handle< Data > value)
void	SetAccessorProperty (Local< Name > name, Local< FunctionTemplate > getter=Local< FunctionTemplate >(), Local< FunctionTemplate > setter=Local< FunctionTemplate >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
void	SetNativeDataProperty (Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Handle< Value > data=Handle< Value >(), PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)
	Whenever the property with the given name is accessed on objects created from this Template the getter and setter callbacks are called instead of getting and setting the property directly on the JavaScript object. More...
void	SetNativeDataProperty (Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Handle< Value > data=Handle< Value >(), PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)
bool	SetDeclaredAccessor (Local< Name > name, Local< DeclaredAccessorDescriptor > descriptor, PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)

Private Member Functions
	Template ()

Friends
class	ObjectTemplate
class	FunctionTemplate

Detailed Description

The superclass of object and function templates.

Definition at line 3347 of file v8.h.

Constructor & Destructor Documentation

Template()

v8::Template::Template ( )

private

Member Function Documentation

Set() [1/2]

void v8::Template::Set	(	v8::Handle< Name >	name,
		v8::Handle< Data >	value,
		v8::PropertyAttribute	attribute = None
	)

Adds a property to each instance created by this template.

Definition at line 802 of file api.cc.

                                                  {
  i::Isolate* isolate = i::Isolate::Current();
  ENTER_V8(isolate);
  i::HandleScope scope(isolate);
  const int kSize = 3;
  v8::Isolate* v8_isolate = reinterpret_cast<v8::Isolate*>(isolate);
  v8::Handle<v8::Data> data[kSize] = {
    name,
    value,
    v8::Integer::New(v8_isolate, attribute)};
  TemplateSet(isolate, this, kSize, data);
}

References ENTER_V8, name, v8::Integer::New(), and v8::TemplateSet().

Here is the call graph for this function:

Set() [2/2]

void v8::Template::Set ( Isolate *  isolate, const char *  name, v8::Handle< Data >  value  )

inline

Definition at line 6421 of file v8.h.

                                                                           {
  Set(v8::String::NewFromUtf8(isolate, name), value);
}

References name, and v8::String::NewFromUtf8().

Here is the call graph for this function:

SetAccessorProperty()

void v8::Template::SetAccessorProperty	(	Local< Name >	name,
		v8::Local< FunctionTemplate >	getter = Local<FunctionTemplate>(),
		v8::Local< FunctionTemplate >	setter = Local<FunctionTemplate>(),
		v8::PropertyAttribute	attribute = None,
		v8::AccessControl	access_control = DEFAULT
	)

Definition at line 818 of file api.cc.

                                    {
  // TODO(verwaest): Remove |access_control|.
  DCHECK_EQ(v8::DEFAULT, access_control);
  i::Isolate* isolate = Utils::OpenHandle(this)->GetIsolate();
  ENTER_V8(isolate);
  DCHECK(!name.IsEmpty());
  DCHECK(!getter.IsEmpty() || !setter.IsEmpty());
  i::HandleScope scope(isolate);
  const int kSize = 5;
  v8::Isolate* v8_isolate = reinterpret_cast<v8::Isolate*>(isolate);
  v8::Handle<v8::Data> data[kSize] = {
    name,
    getter,
    setter,
    v8::Integer::New(v8_isolate, attribute)};
  TemplateSet(isolate, this, kSize, data);
}

References DCHECK, DCHECK_EQ, v8::DEFAULT, ENTER_V8, v8::Handle< T >::IsEmpty(), name, v8::Integer::New(), v8::Utils::OpenHandle(), and v8::TemplateSet().

Here is the call graph for this function:

SetDeclaredAccessor()

bool v8::Template::SetDeclaredAccessor	(	Local< Name >	name,
		Local< DeclaredAccessorDescriptor >	descriptor,
		PropertyAttribute	attribute = None,
		Local< AccessorSignature >	signature = Local<AccessorSignature>(),
		AccessControl	settings = DEFAULT
	)

Definition at line 1337 of file api.cc.

                            {
  void* null = NULL;
  return TemplateSetAccessor(
      this, name, descriptor, null, null, settings, attribute, signature);
}

References name, NULL, and v8::TemplateSetAccessor().

Here is the call graph for this function:

SetNativeDataProperty() [1/2]

void v8::Template::SetNativeDataProperty	(	v8::Local< Name >	name,
		AccessorNameGetterCallback	getter,
		AccessorNameSetterCallback	setter = 0,
		v8::Handle< Value >	data = Handle<Value>(),
		PropertyAttribute	attribute = None,
		v8::Local< AccessorSignature >	signature = Local<AccessorSignature>(),
		AccessControl	settings = DEFAULT
	)

Definition at line 1361 of file api.cc.

                                                             {
  TemplateSetAccessor(
      this, name, getter, setter, data, settings, attribute, signature);
}

References name, and v8::TemplateSetAccessor().

Here is the call graph for this function:

SetNativeDataProperty() [2/2]

void v8::Template::SetNativeDataProperty	(	v8::Local< String >	name,
		AccessorGetterCallback	getter,
		AccessorSetterCallback	setter = 0,
		v8::Handle< Value >	data = Handle<Value>(),
		PropertyAttribute	attribute = None,
		v8::Local< AccessorSignature >	signature = Local<AccessorSignature>(),
		AccessControl	settings = DEFAULT
	)

Whenever the property with the given name is accessed on objects created from this Template the getter and setter callbacks are called instead of getting and setting the property directly on the JavaScript object.

Parameters

name	The name of the property for which an accessor is added.
getter	The callback to invoke when getting the property.
setter	The callback to invoke when setting the property.
data	A piece of data that will be passed to the getter and setter callbacks whenever they are invoked.
settings	Access control settings for the accessor. This is a bit field consisting of one of more of DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2. The default is to not allow cross-context access. ALL_CAN_READ means that all cross-context reads are allowed. ALL_CAN_WRITE means that all cross-context writes are allowed. The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all cross-context access.
attribute	The attributes of the property for which an accessor is added.
signature	The signature describes valid receivers for the accessor and is used to perform implicit instance checks against them. If the receiver is incompatible (i.e. is not an instance of the constructor as defined by FunctionTemplate::HasInstance()), an implicit TypeError is thrown and no callback is invoked.

Definition at line 1349 of file api.cc.

                                                             {
  TemplateSetAccessor(
      this, name, getter, setter, data, settings, attribute, signature);
}

References name, and v8::TemplateSetAccessor().

Here is the call graph for this function:

Friends And Related Function Documentation

FunctionTemplate

friend class FunctionTemplate

friend

Definition at line 3419 of file v8.h.

ObjectTemplate

friend class ObjectTemplate

friend

Definition at line 3418 of file v8.h.

---

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

• /mnt/V8SourceCode/include/v8.h
• /mnt/V8SourceCode/src/api.cc