Module treeInterceptorHandler :: Class TreeInterceptor

Class TreeInterceptor

                   object --+        
                            |        
baseObject.AutoPropertyObject --+    
                                |    
      baseObject.ScriptableObject --+
                                    |
                                   TreeInterceptor

Intercepts events and scripts for a tree of NVDAObjects. When an NVDAObject is encompassed by this interceptor (i.e. it is beneath the root object or it is the root object itself), events will first be executed on this interceptor if implemented. Similarly, scripts on this interceptor take precedence over those of encompassed objects.

Nested Classes

[hide private]

Inherited from baseObject.AutoPropertyObject: __metaclass__

Instance Methods

[hide private]

__init__(self, rootNVDAObject)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

terminate(self)
Terminate this interceptor.

source code

_get_isAlive(self)
Whether this interceptor is alive.

source code

bool

__contains__(self, obj)
Determine whether an object is encompassed by this interceptor.

source code

_get_passThrough(self)
Whether most scripts should temporarily pass through this interceptor without being intercepted.

source code

_set_passThrough(self, state)

source code

prepare(self)
Prepares this treeInterceptor so that it becomes ready to accept event/script input.

source code

Inherited from baseObject.ScriptableObject: bindGesture, bindGestures, clearGestureBindings, getScript

Inherited from baseObject.AutoPropertyObject: invalidateCache

Inherited from baseObject.AutoPropertyObject (private): _getPropertyViaCache

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

[hide private]

Inherited from baseObject.AutoPropertyObject: invalidateCaches

Class Variables

[hide private]

isReady = True

_cache_shouldPrepare = True

shouldPrepare = False
True if this treeInterceptor's prepare method should be called in order to make it ready (e.g.

Inherited from baseObject.AutoPropertyObject: cachePropertiesByDefault

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, rootNVDAObject)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

terminate(self)

source code

Terminate this interceptor. This is called to perform any clean up when this interceptor is being destroyed.

_get_isAlive(self)

source code

Whether this interceptor is alive. If it is not alive, it will be removed.

contains(self, obj)
(In operator)

source code

Determine whether an object is encompassed by this interceptor.

Parameters:

obj (NVDAObjects.NVDAObject) - The object in question.

Returns: bool

True if the object is encompassed by this interceptor.

Class Variable Details

[hide private]

shouldPrepare

True if this treeInterceptor's prepare method should be called in order to make it ready (e.g. load a virtualBuffer, or process the document in some way).

Value:

False

Class TreeInterceptor

__init__(self, rootNVDAObject) (Constructor)

terminate(self)

_get_isAlive(self)

__contains__(self, obj) (In operator)

shouldPrepare

init(self, rootNVDAObject)
(Constructor)

contains(self, obj)
(In operator)