Description
A function that inserts a string.
When this function is seen in markup it is replaced by a string that is set when the function is declared.
Definition at line 232 of file DocumentMarkup.h.
#include <Sawyer/DocumentMarkup.h>
Inheritance diagram for Sawyer::Document::Markup::StaticContent:
Collaboration diagram for Sawyer::Document::Markup::StaticContent:
Public Member Functions | |
| std::string | eval (Grammar &, const std::vector< std::string > &args) override |
| How to evaluate this function or macro. | |
 Public Member Functions inherited from Sawyer::Document::Markup::Function | |
| const std::string & | name () const |
| Function name. | |
| bool | isMacro () const |
| Whether declaration is for a macro. | |
| Ptr | arg (const std::string &name) |
| Declare a required argument. | |
| Ptr | arg (const std::string &name, const std::string &dflt) |
| Declare an optional argument. | |
| Ptr | ellipsis (size_t n=(size_t)(-1)) |
| Declare additional arguments. | |
| size_t | nRequiredArgs () const |
| Number of required arguments. | |
| size_t | nOptionalArgs () const |
| Number of optional arguments. | |
| size_t | nAdditionalArgs () const |
| Max number of additional arguments. | |
| size_t | maxArgs () const |
| Max number of actual arguments possible. | |
| void | validateArgs (std::vector< std::string > &actuals, TokenStream &) const |
| Check and adjust actual arguments. | |
| Public Member Functions inherited from Sawyer::SharedObject | |
| SharedObject () | |
| Default constructor. | |
| SharedObject (const SharedObject &) | |
| Copy constructor. | |
| virtual | ~SharedObject () |
| Virtual destructor. | |
| SharedObject & | operator= (const SharedObject &) |
| Assignment. | |
| Public Member Functions inherited from Sawyer::SharedFromThis< Function > | |
| SharedPointer< Function > | sharedFromThis () |
Create a shared pointer from this. | |
| SharedPointer< const Function > | sharedFromThis () const |
Create a shared pointer from this. | |
Static Public Member Functions | |
| static Ptr | instance (const std::string &name, const std::string str) |
| Create a new instance. | |
Protected Member Functions | |
| StaticContent (const std::string &name, const std::string &resultString) | |
| Protected Member Functions inherited from Sawyer::Document::Markup::Function | |
| Function (const std::string &name, bool evalArgs=true) | |
Additional Inherited Members | |
| Public Types inherited from Sawyer::Document::Markup::Function | |
| typedef SharedPointer< Function > | Ptr |
| Reference-counting pointer to markup function. | |
Constructor & Destructor Documentation
◆ StaticContent()
|
inlineprotected |
Definition at line 235 of file DocumentMarkup.h.
Member Function Documentation
◆ instance()
|
inlinestatic |
◆ eval()
|
overridevirtual |
How to evaluate this function or macro.
Implements Sawyer::Document::Markup::Function.
The documentation for this class was generated from the following file:
