Previous: , Up: Binding Suffix and Infix Commands   [Contents][Index]


5.2.2 Suffix Specifications

A transient’s suffix and infix commands are bound when the transient prefix command is defined using define-transient-command, see Defining Transients. The commands are organized into groups, see Group Specifications. Here we describe the form used to bind an individual suffix command.

The same form is also used when later binding additional commands using functions such as transient-insert-suffix, see Modifying Existing Transients.

Note that an infix is a special kind of suffix. Depending on context "suffixes" means "suffixes (including infixes)" or "non-infix suffixes". Here it means the former.

Suffix specifications have this form:

([LEVEL] [KEY] [DESCRIPTION] COMMAND|ARGUMENT [KEYWORD VALUE]...)

LEVEL, KEY and DESCRIPTION can also be specified using the KEYWORDs :level, :key and :description. If the object that is associated with COMMAND sets these properties, then they do not have to be specified here. You can however specify them here anyway, possibly overriding the objects value just for the binding inside this transient.

The next element is either a command or an argument. This is the only argument that is mandatory in all cases.

Finally details can be specified using optional KEYWORD-VALUE pairs. Each keyword has to be a keyword symbol, either :class or a keyword argument supported by the constructor of that class. See Suffix Slots.


Previous: , Up: Binding Suffix and Infix Commands   [Contents][Index]