kspread
KSpread::Function Class Reference
A function pointer and context. More...
#include <Functions.h>
Inherited by ScriptingFunctionImpl.
Public Member Functions | |
| Function (const QString &name, FunctionPtr ptr) | |
| virtual | ~Function () |
| Value | exec (valVector args, ValueCalc *calc, FuncExtra *extra=0) |
| QString | helpText () const |
| QString | localizedName () const |
| QString | name () const |
| bool | needsExtra () |
| bool | paramCountOkay (int count) |
| void | setAcceptArray (bool accept=true) |
| void | setHelpText (const QString &text) |
| void | setNeedsExtra (bool extra) |
| void | setParamCount (int min, int max=0) |
Detailed Description
A function pointer and context.
Definition at line 59 of file Functions.h.
Constructor & Destructor Documentation
| Function::Function | ( | const QString & | name, | |
| FunctionPtr | ptr | |||
| ) |
Definition at line 67 of file Functions.cpp.
| Function::~Function | ( | ) | [virtual] |
Definition at line 78 of file Functions.cpp.
Member Function Documentation
Definition at line 117 of file Functions.cpp.
| QString KSpread::Function::helpText | ( | ) | const |
| QString KSpread::Function::localizedName | ( | ) | const |
| QString Function::name | ( | ) | const |
Definition at line 83 of file Functions.cpp.
| bool Function::needsExtra | ( | ) |
Definition at line 110 of file Functions.cpp.
| bool Function::paramCountOkay | ( | int | count | ) |
is it okay for the function to receive this many parameters ?
Definition at line 94 of file Functions.cpp.
| void Function::setAcceptArray | ( | bool | accept = true |
) |
when set to true, the function can receive arrays.
When set to false, the auto-array mechamism will be used for arrays (so the function will receive simple values, not arrays).
Definition at line 106 of file Functions.cpp.
| void KSpread::Function::setHelpText | ( | const QString & | text | ) |
| void Function::setNeedsExtra | ( | bool | extra | ) |
Definition at line 113 of file Functions.cpp.
| void Function::setParamCount | ( | int | min, | |
| int | max = 0 | |||
| ) |
setParamCount sets allowed parameter count for a function.
if max=0, it means max=min. If max=-1, there is no upper limit.
Definition at line 88 of file Functions.cpp.
The documentation for this class was generated from the following files:
