TextArgument Class Reference

A text argument. More...

#include <Function.h>

Inheritance diagram for TextArgument:

Argument

List of all members.

Public Member Functions

 TextArgument (string name_="", bool does_test=true, bool does_error=true)
 TextArgument (const TextArgument *arg)
virtual int type () const
virtual Argumentcopy () const
virtual string print () const
virtual bool suggestsQuotes () const

Protected Member Functions

virtual bool subtest (MathStructure &value, const EvaluationOptions &eo) const
virtual string subprintlong () const


Detailed Description

A text argument.

Accepts text (symbolic) structures. Argument values are parsed as text, unless surrounded by back slashes (which are then removed). Surrounding Parentheses and first quotation marks are removed.


Member Function Documentation

virtual bool TextArgument::subtest ( MathStructure value,
const EvaluationOptions eo 
) const [protected, virtual]

This function is called from Argument::test() and performs validation specific to the argument definition type. Should be reimplemented by all subclasses.

Parameters:
value Value to test.
eo Evaluation options to use if the value needs to be evaluated.
Returns:
true if the value is valid for the argument definition.

Reimplemented from Argument.

virtual string TextArgument::subprintlong (  )  const [protected, virtual]

This function is called from Argument::printlong() and returns description specific the argument definition type. Should be reimplemented by all subclasses. For example IntegerArgument::subprintlong() might return "an integer" and Argument::printlong() might append " that fulfills the condition: even(\x)".

Returns:
Long description.

Reimplemented from Argument.

virtual int TextArgument::type (  )  const [virtual]

Returns the type of the argument, corresponding to which subclass the object belongs to.

Returns:
ArgumentType.

Reimplemented from Argument.

virtual Argument* TextArgument::copy (  )  const [virtual]

Returns a copy of the argument definition.

Returns:
A copy.

Reimplemented from Argument.

virtual string TextArgument::print (  )  const [virtual]

Resturns a short description of the argument definition. Ex. "number" for NumberArgument.

Returns:
Short description.

Reimplemented from Argument.


The documentation for this class was generated from the following file:

Generated on Tue Jan 5 08:26:29 2010 for libqalculate-0.9.7 by  doxygen 1.5.5