Uses of Class
uk.ac.ed.ph.snuggletex.definitions.LaTeXMode

Packages that use LaTeXMode

Package	Description
uk.ac.ed.ph.snuggletex	Public API Package - almost all of the classes you will need for normal SnuggleTeX use are contained in here.
uk.ac.ed.ph.snuggletex.definitions	Defines built-in commands, environments, accent maps, globals and related concepts.
uk.ac.ed.ph.snuggletex.internal	This package contains the guts of SnuggleTeX; classes here are responsible for the parsing process, token fixing and DOM/web building.
uk.ac.ed.ph.snuggletex.tokens	Internal package defining the various types of LaTeX tokens produced by the parsing process.

Uses of LaTeXMode in uk.ac.ed.ph.snuggletex

Methods in uk.ac.ed.ph.snuggletex with parameters of type LaTeXMode

Modifier and Type	Method and Description
BuiltinCommand	SnugglePackage.addComplexCommand(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommandOneArg(String name, boolean allowOptionalArgument, EnumSet<LaTeXMode> allowedModes, LaTeXMode argumentMode, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommandOneArg(String name, boolean allowOptionalArgument, EnumSet<LaTeXMode> allowedModes, LaTeXMode argumentMode, Interpretation interpretation, CommandHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, boolean allowOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation[] interpretations, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, boolean allowOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation interpretation, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation[] interpretations, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation interpretation, EnvironmentHandler handler, TextFlowContext context)

Method parameters in uk.ac.ed.ph.snuggletex with type arguments of type LaTeXMode

Modifier and Type	Method and Description
BuiltinCommand	SnugglePackage.addCombinerCommand(String name, EnumSet<LaTeXMode> allowedModes, CombinerTargetMatcher combinerTargetMatcher, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommand(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommandOneArg(String name, boolean allowOptionalArgument, EnumSet<LaTeXMode> allowedModes, LaTeXMode argumentMode, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommandOneArg(String name, boolean allowOptionalArgument, EnumSet<LaTeXMode> allowedModes, LaTeXMode argumentMode, Interpretation interpretation, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommandSameArgMode(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addComplexCommandSameArgMode(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, Interpretation interpretation, CommandHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, boolean allowOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation[] interpretations, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, boolean allowOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation interpretation, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation[] interpretations, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	SnugglePackage.addEnvironment(String name, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation interpretation, EnvironmentHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addSimpleCommand(String name, EnumSet<LaTeXMode> allowedModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addSimpleCommand(String name, EnumSet<LaTeXMode> allowedModes, Interpretation[] interpretations, CommandHandler handler, TextFlowContext context)
BuiltinCommand	SnugglePackage.addSimpleCommand(String name, EnumSet<LaTeXMode> allowedModes, Interpretation interpretation, CommandHandler handler, TextFlowContext context)

Uses of LaTeXMode in uk.ac.ed.ph.snuggletex.definitions

Fields in uk.ac.ed.ph.snuggletex.definitions with type parameters of type LaTeXMode

Modifier and Type	Field and Description
static EnumSet<LaTeXMode>	Globals.ALL_MODES This represents all modes that LaTeX commands can be used in, so is currently a bit of a misnomer as it excludes VERBATIM!
static EnumSet<LaTeXMode>	Globals.MATH_MODE_ONLY
static EnumSet<LaTeXMode>	Globals.PARA_MODE_ONLY
static EnumSet<LaTeXMode>	Globals.TEXT_MODE_ONLY

Methods in uk.ac.ed.ph.snuggletex.definitions that return LaTeXMode

Modifier and Type	Method and Description
LaTeXMode	UserDefinedCommandOrEnvironment.getArgumentMode(int argumentIndex) User-defined commands and environments stay in the same mode when parsing arguments.
LaTeXMode	CommandOrEnvironment.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.
LaTeXMode	BuiltinEnvironment.getArgumentMode(int argumentIndex) (Currently all built-in environments parse their arguments in PARAGRAPH.)
LaTeXMode	BuiltinCommand.getArgumentMode(int argumentIndex)
LaTeXMode	UserDefinedEnvironment.getContentMode() Use existing content mode
LaTeXMode	Environment.getContentMode() Specifies which mode to parse content in.
LaTeXMode	BuiltinEnvironment.getContentMode()
static LaTeXMode	LaTeXMode.valueOf(String name) Returns the enum constant of this type with the specified name.
static LaTeXMode[]	LaTeXMode.values() Returns an array containing the constants of this enum type, in the order they are declared.

Constructors in uk.ac.ed.ph.snuggletex.definitions with parameters of type LaTeXMode

Constructor and Description
BuiltinCommand(String texName, CommandType commandType, boolean allowingOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, EnumMap<InterpretationType,Interpretation> interpretations, CommandHandler domBuilderHandler, TextFlowContext textFlowContext, CombinerTargetMatcher combinerTargetMatcher)
BuiltinEnvironment(String texName, boolean allowingOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, EnumMap<InterpretationType,Interpretation> interpretations, EnvironmentHandler domBuildingHandler, TextFlowContext textFlowContext)

Constructor parameters in uk.ac.ed.ph.snuggletex.definitions with type arguments of type LaTeXMode

Constructor and Description
BuiltinCommand(String texName, CommandType commandType, boolean allowingOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, EnumMap<InterpretationType,Interpretation> interpretations, CommandHandler domBuilderHandler, TextFlowContext textFlowContext, CombinerTargetMatcher combinerTargetMatcher)
BuiltinEnvironment(String texName, boolean allowingOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, EnumMap<InterpretationType,Interpretation> interpretations, EnvironmentHandler domBuildingHandler, TextFlowContext textFlowContext)

Uses of LaTeXMode in uk.ac.ed.ph.snuggletex.internal

Fields in uk.ac.ed.ph.snuggletex.internal declared as LaTeXMode

Modifier and Type	Field and Description
LaTeXMode	LaTeXTokeniser.ModeState.latexMode Current LaTeX mode we are parsing in

Constructors in uk.ac.ed.ph.snuggletex.internal with parameters of type LaTeXMode

Constructor and Description
ModeState(LaTeXTokeniser.TokenisationMode tokenisationMode, LaTeXMode latexMode, int startPosition, LaTeXTokeniser.Terminator terminator)

Uses of LaTeXMode in uk.ac.ed.ph.snuggletex.tokens

Fields in uk.ac.ed.ph.snuggletex.tokens declared as LaTeXMode

Modifier and Type	Field and Description
protected LaTeXMode	Token.latexMode LaTeX Mode that this token was parsed in

Methods in uk.ac.ed.ph.snuggletex.tokens that return LaTeXMode

Modifier and Type	Method and Description
LaTeXMode	Token.getLatexMode()

Methods in uk.ac.ed.ph.snuggletex.tokens with parameters of type LaTeXMode

Modifier and Type	Method and Description
static ArgumentContainerToken	ArgumentContainerToken.createEmptyContainer(Token parentToken, LaTeXMode latexMode, ComputedStyle computedStyle)
static ArgumentContainerToken	ArgumentContainerToken.createFromContiguousTokens(Token parentToken, LaTeXMode latexMode, List<? extends FlowToken> contents, ComputedStyle computedStyle)
static ArgumentContainerToken	ArgumentContainerToken.createFromContiguousTokens(Token parentToken, LaTeXMode latexMode, List<? extends FlowToken> contents, int startIndex, int endIndex, ComputedStyle computedStyle)
static ArgumentContainerToken	ArgumentContainerToken.createFromSingleToken(LaTeXMode latexMode, FlowToken content)
static ArgumentContainerToken	ArgumentContainerToken.createFromSingleToken(LaTeXMode latexMode, FlowToken content, ComputedStyle computedStyle)

Constructors in uk.ac.ed.ph.snuggletex.tokens with parameters of type LaTeXMode

Constructor and Description
ArgumentContainerToken(FrozenSlice slice, LaTeXMode latexMode, List<FlowToken> contents)
ArgumentContainerToken(FrozenSlice slice, LaTeXMode latexMode, List<FlowToken> contents, ComputedStyle computedStyle)
BraceContainerToken(FrozenSlice slice, LaTeXMode latexMode, List<FlowToken> contents)
CommandToken(FrozenSlice slice, LaTeXMode latexMode, BuiltinCommand command)
CommandToken(FrozenSlice slice, LaTeXMode latexMode, BuiltinCommand command, ArgumentContainerToken combinerTarget)
CommandToken(FrozenSlice slice, LaTeXMode latexMode, BuiltinCommand command, ArgumentContainerToken optionalArgument, ArgumentContainerToken[] arguments)
EnvironmentToken(FrozenSlice slice, LaTeXMode latexMode, BuiltinEnvironment environment, ArgumentContainerToken content)
EnvironmentToken(FrozenSlice slice, LaTeXMode latexMode, BuiltinEnvironment environment, ArgumentContainerToken optionalArgument, ArgumentContainerToken[] arguments, ArgumentContainerToken content)
ErrorToken(InputError error, LaTeXMode latexMode)
FlowToken(FrozenSlice slice, TokenType type, LaTeXMode latexMode, TextFlowContext textFlowContext, EnumMap<InterpretationType,Interpretation> interpretations)
FlowToken(FrozenSlice slice, TokenType type, LaTeXMode latexMode, TextFlowContext textFlowContext, Interpretation... interpretations)
SimpleToken(FrozenSlice slice, TokenType tokenType, LaTeXMode latexMode, TextFlowContext context, EnumMap<InterpretationType,Interpretation> interpretations)
SimpleToken(FrozenSlice slice, TokenType tokenType, LaTeXMode latexMode, TextFlowContext context, Interpretation... interpretations)
Token(FrozenSlice slice, TokenType type, LaTeXMode latexMode, EnumMap<InterpretationType,Interpretation> interpretationMap)
Token(FrozenSlice slice, TokenType type, LaTeXMode latexMode, Interpretation... interpretations)