user_interface_api.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_USER_INTERFACE_API_H
#define AUBO_SCOPE_USER_INTERFACE_API_H
 
#include <aubo_caps/domain/user_interface/user_interaction.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(UserInterfaceApi);
 
/**
 * \chinese
 * @defgroup UserInterfaceApi UserInterfaceApi(用户界面)
 * @ingroup UserInterfaceApi
 * 用户界面接口
 * 提供对 AuboScope 中与用户界面和终端用户交互相关的功能和服务访问。
 * \endchinese
 * \english
 * @defgroup UserInterfaceApi UserInterfaceApi
 * @ingroup UserInterfaceApi
 * UserInterfaceApi
 * Provides access to functionality and services available from within AuboScope
 * related to user interface and end user interaction.
 * \endenglish
 */
class ARCS_ABI_EXPORT UserInterfaceApi
{
public:
    UserInterfaceApi(UserInterfaceApi &f);
    UserInterfaceApi(UserInterfaceApi &&f);
    virtual ~UserInterfaceApi();
 
    /**
     * @ingroup UserInterfaceApi
     * @ref UserInteraction
     * \chinese
     * @return 提供向终端用户请求输入和操作功能的接口
     * \endchinese
     * \english
     * @return An interface which provides functionality for requesting input
     * and actions from end users.
     * \endenglish
     */
    UserInteractionPtr getUserInteraction();
 
private:
    friend class DataSwitch;
    UserInterfaceApi();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_USER_INTERFACE_API_H