class Object extends Any
Object(对象) 是派生其他 AutoHotkey 对象类的基本类. Object 的每个实例都由一组 "自有属性" 和一个基对象组成, 可以从基对象中继承更多的属性. Object 也有方法, 但这些只是可以调用的属性.
有值属性和动态属性. 值属性只是包含一个值. 动态属性不包含一个值, 而是根据访问方式(get, set 或 call) 调用一个 访问函数.
下面使用 "Obj" 作为 Object 类的任何实例的占位符.
所有 Object 的实例都基于 Object.Prototype
, 而其又基于 Any.Prototype
. 除了从 Any 继承的方法和属性外, Object 还具有以下预定义的方法和属性.
创建一个新对象.
Obj := Object()
Obj := Object.Call()
返回对象的一个浅拷贝.
Clone := Obj.Clone()
对象拥有的每个属性或方法都被复制到副本中. 对象 引用 被复制(就像普通的赋值一样), 而不是对象本身; 换句话说, 如果属性包含对对象的引用, 则副本将包含对同一对象的引用.
动态属性被复制, 而不是调用.
副本具有与原始对象相同的基对象.
如果 Obj 派生自不支持的内置类型, 则抛出 TypeError. Clone 的实现支持 Object, Class 和 Error 对象. 另请参阅: Clone (Array), Clone (Map).
定义一个新的自有属性.
Obj := Obj.DefineProp(Name, Descriptor)
类型: 字符串
属性的名称.
类型: Object
具有以下自有属性之一的对象, 或同时具有 Get 和 Set:
Get:: 获取属性值时调用的函数对象.
Set:: 属性被赋值时调用的函数对象. 第二个参数是要分配的值.
Call:: 调用该属性时要调用的函数对象.
Value:: 要赋值该属性的任何值.
类型: Object
此方法返回目标对象(Obj).
该方法可用于将值属性转换为动态属性, 反之亦然, 但不可能同时指定一个值和访问函数.
如果省略任何一个访问函数, 行为就会从基对象中继承.
this
中存储一个新的值. 注意, 一个新的值将覆盖其在 this
本身中的任何动态属性, 并覆盖任何继承的访问函数.与方法一样, Get, Set 或 Call 的第一个参数是 this
(目标对象). 对于 Set, 第二个参数是 value
(被分配的值). 这些参数由类中的方法和属性定义自动定义, 但如果使用普通函数, 则必须显式定义. 调用者传递的任何其他参数都会附加到参数列表中.
计算函数对象的 MaxParams 和 IsVariadic 属性, 以确定该属性是否可以接受参数. 如果 Get 的 MaxParams 为 1, 或 Set 的 MaxParams 为 2, 并且 IsVariadic 为 false 或未定义, 则属性不能接受参数; 它们被转发到由 get 返回的对象的 __Item 属性.
删除对象拥有的属性.
RemovedValue := Obj.DeleteProp(Name)
类型: 字符串
属性名.
类型: Any
此方法返回删除属性的值(如果没有则为空).
返回给定自有属性的描述符, 兼容于 DefineProp.
Descriptor := Obj.GetOwnPropDesc(Name)
类型: 字符串
属性名.
类型: Object
对于动态属性, 返回值是一个新对象, 其中每个访问函数都有自己的属性: Get, Set, Call. 只有在 Obj 本身定义了相应的访问函数, 每个属性才会存在. 对于值属性, 返回值是一个新对象, 其属性名为 Value
. 在这种情况下, Obj.GetOwnPropDesc(Name).Value == Obj.%Name%
.
除非调用 DefineProp, 否则修改返回的对象对 Obj 没有影响.
如果 Obj 不拥有该名称的属性, 则抛出 PropertyError. 脚本可以通过检查 not desc.HasProp("Value")
来确定一个属性是否是动态的, 其中 desc 是 GetOwnPropDesc 的返回值.
如果对象拥有该名称的属性, 则返回 1(true), 否则返回 0(false).
HasOwnProp := Obj.HasOwnProp(Name)
该方法的默认实现也被定义为一个函数: ObjHasOwnProp(Obj, Name)
.
枚举一个对象自有的属性.
For Name , Value in Obj.OwnProps()
此方法返回一个新的枚举器. 该枚举器通常直接传递给 for-loop, 循环的每次迭代都调用一次枚举器. 每次对枚举器的调用都会返回下一个属性名和/或其值. for-loop 的变量对应于枚举器的参数, 它们是:
动态属性包含在枚举中. 但是:
注意: 由方法定义定义的属性通常没有 getter, 因此会被跳过.
要在不调用属性获取器(getters) 的情况下枚举自有的属性, 或者要枚举所有的属性而不考虑类型, 只需向 for-loop 或枚举器传递一个变量. GetOwnPropDesc 可以用来区分值属性和动态属性, 同时还可以检索值或获取器/设置器(setter)/方法.
方法通常被排除在双参数模式的枚举之外, 因为属性的计算通常取决于对象是否有相应的 getter 或值(在同一对象或基对象中). 为了避免在指定两个变量时出现不一致, OwnProps 跳过了只有一个 Call 访问函数的自有属性. 例如:
该方法的默认实现也被定义为一个函数: ObjOwnProps(Obj)
.
检索或设置一个对象的基对象.
CurrentBaseObj := Obj.Base
Obj.Base := NewBaseObj
NewBaseObj 必须是一个对象.
如果给新基赋值会改变对象的原生类型, 则抛出异常. 对象的原生类型由属于内置类的最近原型对象决定, 例如 Object.Prototype
或 Array.Prototype
. 例如, Array 的实例必须始终直接或间接地从 Array.Prototype
派生.
属性和方法是从基对象动态继承的, 因此更改对象的基也会更改哪些可用继承的属性和方法.
属性继承于 Any; 但是, 只能为 Object 的实例设置它.
另请参阅: ObjGetBase, ObjSetBase
设置一个对象的基对象.
ObjSetBase(Obj, BaseObj)
不调用元-函数或属性函数. 覆盖 Base 属性不会影响此函数的行为.
如果 Obj 或 BaseObj 的类型不正确, 则抛出异常.
另请参阅: ObjGetBase, Base 属性
返回对象拥有的属性的数量.
Count := ObjOwnPropCount(Obj)
设置对象内部自有属性的当前容量.
MaxProps := ObjSetCapacity(Obj, MaxProps)
类型: 整数
新的容量. 如果小于自有属性的当前数量, 则使用该数量, 并释放所有未使用的空间.
类型: 整数
此函数返回新容量.
如果 Obj 的类型不正确, 则抛出异常.
返回对象内部属性数组的当前容量.
MaxItems := ObjGetCapacity(Obj)
如果 Obj 的类型不正确, 则抛出异常.