Next: , Previous: , Up: Defining New Commands   [Contents][Index]


5.4 Using Infix Arguments

The function and the variables described below allow suffix commands to access the value of the transient from which they were invoked; which is the value of its infix arguments. These variables are set when the user invokes a suffix command that exits the transient, but before actually calling the command.

When returning to the command-loop after calling the suffix command, the arguments are reset to nil (which causes the function to return nil too).

Like for Emacs’ prefix arguments it is advisable, but not mandatory, to access the infix arguments inside the command’s interactive form. The preferred way of doing that is to call the transient-args function, which for infix arguments serves about the same purpose as prefix-arg serves for prefix arguments.

Function: transient-args &optional prefix

This function returns the value of the transient prefix command PREFIX.

If the current command was invoked from the transient prefix command PREFIX, then it returns the active infix arguments. If the current command was not invoked from PREFIX, then it returns the set, saved or default value for PREFIX.

Variable: transient-current-suffixes

The suffixes of the transient from which this suffix command was invoked. This is a list of objects. Usually it is sufficient to instead use the function transient-args, which returns a list of values. In complex cases it might be necessary to use this variable instead, i.e. if you need access to information beside the value.

Variable: transient-current-prefix

The transient from which this suffix command was invoked. The returned value is a transient-prefix object, which holds information associated with the transient prefix command.

Variable: transient-current-command

The transient from which this suffix command was invoked. The returned value is a symbol, the transient prefix command.


Next: , Previous: , Up: Defining New Commands   [Contents][Index]