usmtf::Macro Class Reference

#include <Macro.hpp>

Inheritance diagram for usmtf::Macro:

Collaboration diagram for usmtf::Macro:

Public Member Functions
	Macro (const std::string &aKey, const std::string &aInputScaffold) noexcept
InputBlock	GetInputBlock () const override
const std::string &	GetKey () const noexcept
const std::string	GetPlaceholder () const noexcept
Public Member Functions inherited from usmtf::Exportable
virtual	~Exportable ()=default

Detailed Description

A Macro is just a collection of data that is intended to be filled in by the user.

Constructor & Destructor Documentation

Macro()

usmtf::Macro::Macro ( const std::string & aKey, const std::string & aInputScaffold )

explicitnoexcept

Member Function Documentation

GetInputBlock()

InputBlock usmtf::Macro::GetInputBlock ( ) const

overridevirtual

Implements usmtf::Exportable.

References usmtf::InputBlock::AddProperty().

GetKey()

const std::string & usmtf::Macro::GetKey ( ) const

noexcept

used for indexing into collection of these to avoid duplicates. It doesnt make sense to have two macros with the same name in a single export.

Referenced by usmtf::MacroEnabled::AddMacro().

GetPlaceholder()

const std::string usmtf::Macro::GetPlaceholder ( ) const

noexcept

---

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

• Macro.hpp
• Macro.cpp