uk.ac.ed.ph.snuggletex.definitions

接口 CommandOrEnvironment

所有已知子接口:

Command, Environment

所有已知实现类:

BuiltinCommand, BuiltinEnvironment, UserDefinedCommand, UserDefinedCommandOrEnvironment, UserDefinedEnvironment

public interface CommandOrEnvironment

Base interface for LaTeX commands and environments.

方法概要

限定符和类型	方法和说明
int	getArgumentCount() Returns the number of mandatory arguments this command expects, which will be zero or greater.
LaTeXMode	getArgumentMode(int argumentIndex) Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order.
java.lang.String	getTeXName() Returns the TeX name for this command or environment.
boolean	isAllowingOptionalArgument() Returns whether this command/environment takes an optional argument.

方法详细资料

getTeXName

java.lang.String getTeXName()

Returns the TeX name for this command or environment. (In the case of commands, this does not include the leading backslash.)

isAllowingOptionalArgument

boolean isAllowingOptionalArgument()

Returns whether this command/environment takes an optional argument. As per LaTeX convention, this will only return true if the command/environment takes at least one mandatory argument as well.

getArgumentCount

int getArgumentCount()

Returns the number of mandatory arguments this command expects, which will be zero or greater.

getArgumentMode

LaTeXMode getArgumentMode(int argumentIndex)

Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order. Null entries indicate that the current LaTeX mode should be used.