A.11 Using the Property API

以下是用于操作属性的相关函数说明。

Function: org-entry-properties &optional pom which

获取光标或标记 POM 处条目的所有属性。包括 TODO 关键字、标签、截止日期与计划时间的时间字符串、计时信息,以及条目内定义的其他属性。返回值为关联列表。若属性键被多次使用,键名可重复出现。POM 可为 nil ,此时使用当前条目。若 WHICHnilall ,获取全部属性;若为 specialstandard ,仅获取对应子类属性。

Function: org-entry-get pom property &optional inherit

获取光标或标记 POM 处条目 PROPERTY 属性的值。默认仅检查条目本地定义的属性。若 INHERITnil 且条目无该属性,则向上层级查找。若 INHERIT 为符号 selective ,则仅当 org-use-property-inheritance 允许该属性 PROPERTY 继承时,才执行继承查找。

Function: org-entry-delete pom property

删除光标或标记 POM 处条目的 PROPERTY 属性。

Function: org-entry-put pom property value

Set PROPERTY to VALUES for entry at point-or-marker POM.

Function: org-buffer-property-keys &optional include-specials

获取当前缓冲区中的所有属性键。

Function: org-insert-property-drawer

为当前条目插入属性抽屉。

Function: org-entry-put-multivalued-property pom property &rest values

将光标或标记 POM 处的 PROPERTY 属性设为 VALUESVALUES 应为字符串列表,以空格分隔拼接。

Function: org-entry-get-multivalued-property pom property

PROPERTY 属性的值视为空白分隔的值列表,并以字符串列表形式返回。

Function: org-entry-add-to-multivalued-property pom property value

PROPERTY 属性的值视为空白分隔的值列表,确保 VALUE 存在于列表中。

Function: org-entry-remove-from-multivalued-property pom property value

PROPERTY 属性的值视为空白分隔的值列表,确保 VALUE 不在列表中。

Function: org-entry-member-in-multivalued-property pom property value

PROPERTY 属性的值视为空白分隔的值列表,检查 VALUE 是否在列表中。

User Option: org-property-allowed-value-functions

为特定属性提供可选值的函数钩子。函数接收属性名作为参数,返回可选值列表。若值包含 ‘:ETC’ ,则该列表仅用作补全提示,允许输入其他值。若函数不处理该属性,返回 nil