kspread
KSpread::Formula Class Reference
#include <formula.h>
Detailed Description
Class Formula encapsulates a formula for a cell.A Formula is a equations which perform calculations on values in the cells and sheets. Every formula must start with an equal sign (=).
Definition at line 238 of file formula.h.
Public Member Functions | |
Formula (Sheet *sheet, Cell *cell=0) | |
Formula () | |
~Formula () | |
Sheet * | sheet () const |
Cell * | cell () const |
void | setExpression (const QString &expr) |
QString | expression () const |
void | clear () |
bool | isValid () const |
Tokens | tokens () const |
Value | eval () const |
Tokens | scan (const QString &expr, KLocale *locale=0) const |
QString | dump () const |
Protected Member Functions | |
void | compile (const Tokens &tokens) const |
bool | isNamedArea (const QString &expr) const |
Constructor & Destructor Documentation
Formula::Formula | ( | Sheet * | sheet, | |
Cell * | cell = 0 | |||
) |
Creates a formula.
It must be owned by a sheet, and optionally sheet.
Definition at line 370 of file formula.cc.
Formula::Formula | ( | ) |
Creates a formula that is not owned by any sheet.
This might be useful in some cases.
Definition at line 378 of file formula.cc.
Formula::~Formula | ( | ) |
Member Function Documentation
Sheet * Formula::sheet | ( | ) | const |
Cell * Formula::cell | ( | ) | const |
void Formula::setExpression | ( | const QString & | expr | ) |
QString Formula::expression | ( | ) | const |
void Formula::clear | ( | ) |
Clears everything, makes as like a newly constructed formula.
Definition at line 442 of file formula.cc.
bool Formula::isValid | ( | ) | const |
Returns true if the specified expression is valid, i.e.
it contains no parsing error. Empty formula (i.e. without expression) is always invalid.
Definition at line 424 of file formula.cc.
Tokens Formula::tokens | ( | ) | const |
Returns list of tokens associated with this formula.
This has nothing to with the formula evaluation but might be useful, e.g. for syntax highlight or similar features. If the formula contains error, the returned tokens is invalid.
Definition at line 456 of file formula.cc.
Value Formula::eval | ( | ) | const |
Tokens Formula::scan | ( | const QString & | expr, | |
KLocale * | locale = 0 | |||
) | const |
Given an expression, this function separates it into tokens.
If the expression contains error (e.g. unknown operator, string no terminated) this function returns tokens which is not valid.
Definition at line 464 of file formula.cc.
bool Formula::isNamedArea | ( | const QString & | expr | ) | const [protected] |
The documentation for this class was generated from the following files: