view_api_provider.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_VIEW_API_PROVIDER_H
#define AUBO_SCOPE_VIEW_API_PROVIDER_H
 
#include <aubo_caps/domain/system_api.h>
#include <aubo_caps/domain/user_interface/user_interface_api.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ViewApiProvider);
 
/**
 * \chinese
 * 视图 API 提供者
 * 提供与安装或程序节点贡献的视图（UI）相关的功能访问。
 *
 * <b>注意：</b>此接口不适用于具有基于 HTML 用户界面的 AuboCap 程序和安装节点。
 * \endchinese
 * \english
 * ViewApiProvider
 * Provides access to functionality relevant for the View (UI) of an
 * installation or a program node contribution.
 *
 * <b>NOTE:</b> This interface is not relevant for AuboCap program and
 * installation nodes with a HTML-based user interface.
 * \endenglish
 */
class ViewApiProvider
{
public:
    ViewApiProvider();
    ViewApiProvider(ViewApiProvider &f);
    ViewApiProvider(ViewApiProvider &&f);
    virtual ~ViewApiProvider();
 
    /**
     * \chinese
     * 提供对系统相关功能的访问。
     *
     * @return SystemAPI 实例
     * \endchinese
     * \english
     * Provides access to system related functionality.
     *
     * @return an instance of SystemAPI.
     * \endenglish
     */
    SystemApiPtr getSystemApi();
 
    /**
     * \chinese
     * 提供对用户界面和用户交互相关功能的访问。
     *
     * @return UserInterfaceAPI 实例
     * \endchinese
     * \english
     * Provides access to functionality related to user interface and user
     * interaction.
     *
     * @return an instance of UserInterfaceAPI.
     * \endenglish
     */
    UserInterfaceApiPtr getUserInterfaceApi();
 
private:
    friend class DataSwitch;
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_VIEW_API_PROVIDER_H