installation_node_contribution.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_INSTALLATION_NODE_CONTRIBUTION_H
#define AUBO_SCOPE_INSTALLATION_NODE_CONTRIBUTION_H
 
#include <aubo_caps/domain/script/script_writer.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(InstallationNodeContribution);
 
/**
 * \chinese
 * 安装节点贡献
 * 安装节点贡献的 API。
 * \endchinese
 * \english
 * InstallationNodeContribution
 * API for installation node contributions.
 * \endenglish
 */
class InstallationNodeContribution
{
public:
    virtual ~InstallationNodeContribution() = default;
 
    /**
     * \chinese
     * 当终端用户每次在安装标签页中打开此 AuboCap 贡献时调用。
     * \endchinese
     * \english
     * Called each time the end user opens this AuboCap contribution in the
     * Installation Tab.
     * \endenglish
     */
    virtual void openView() = 0;
 
    /**
     * \chinese
     * 当终端用户每次在安装标签页中退出此 AuboCap 贡献时调用。
     * \endchinese
     * \english
     * Called each time the end user exits this AuboCap contribution in the
     * Installation Tab.
     * \endenglish
     */
    virtual void closeView() = 0;
 
    /**
     * \chinese
     * 定义添加到程序启动时执行的脚本代码开头的脚本代码。
     *
     * @param script_writer 用于向程序脚本代码前言添加脚本命令
     * \endchinese
     * \english
     * Defines script code that is added to the beginning of the script code
     * executed when a program is launched.
     *
     * @param script_writer serves to add script commands to program script code
     * preamble.
     * \endenglish
     */
    virtual void generateScript(ScriptWriterPtr script_writer) = 0;
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_INSTALLATIONNODECONTRIBUTION_H