AuboStudio SDK 0.6.3

Public 成员函数 | 所有成员列表
arcs::aubo_scope::InstallationNodeService类 参考abstract

Defines an API required for defining and adding to AuboScope an installation node and corresponding screen where the user interface is Swing-based. 更多...

`#include <installation_node_service.h>`

## Public 成员函数
virtual | ~InstallationNodeService ()=default
virtual std::string | getTitle ()=0
virtual std::string | getIcon ()=0
virtual void | configureContribution (InstallationContributionConfigurationPtr configuration)=0
| This method is called once after this service is registered. 更多...
virtual InstallationNodeViewPtr | createView (ViewApiProviderPtr api_provider)=0
| Creates a new View instance which implements the UI for your installation node screen. 更多...
virtual InstallationNodeContributionPtr | createInstallationNode (InstallationApiProviderPtr api_provider, InstallationNodeViewPtr view, DataModelPtr model, InstallationCreationContextPtr context)=0

## 详细描述

Defines an API required for defining and adding to AuboScope an installation node and corresponding screen where the user interface is Swing-based.

在文件 installation_node_service.h 第 21 行定义.

## 构造及析构函数说明

## ◆ ~InstallationNodeService()

virtual arcs::aubo_scope::InstallationNodeService::~InstallationNodeService | ( |  | ) |
| virtual default

## 成员函数说明

## ◆ configureContribution()

virtual void arcs::aubo_scope::InstallationNodeService::configureContribution | ( | InstallationContributionConfigurationPtr | configuration | ) |
| pure virtual

This method is called once after this service is registered.

Modify the configuration parameter to configure your contribution/ The configuration object will already have default values for its properties matching most use cases.

The values of the ContributionConfiguration object will be read once immediately after this method call. Changing values at a later stage will have no effect, so do not store a reference to the configuration object.

If the default values are appropriate, leave this method empty.

参数

  configuration | a modifiable ContributionConfiguration with default values

## ◆ createInstallationNode()

virtual InstallationNodeContributionPtr arcs::aubo_scope::InstallationNodeService::createInstallationNode | ( | InstallationApiProviderPtr | api_provider,
|  | InstallationNodeViewPtr | view,
|  | DataModelPtr | model,
|  | InstallationCreationContextPtr | context
| ) |  |
| pure virtual

Creates a new installation node instance.

The returned node must use the supplied data model object to retrieve and store the data contained in it. All modifications to the supplied data model from the installation node constructor are ignored when an existing installation is loaded. The data model object is shared between all installation nodes contributed by the same AuboCap.

参数

  api_provider | Provides access to functionality and services available from within AuboScope relevant for the installation node
  view | the View created by createView(ViewAPIProvider)
  model | object where all configuration data of the new installation node instance is to be stored in and retrieved from
  context | the context in which this node is created

返回
  the newly constructed installation node contribution instance

## ◆ createView()

virtual InstallationNodeViewPtr arcs::aubo_scope::InstallationNodeService::createView | ( | ViewApiProviderPtr | api_provider | ) |
| pure virtual

Creates a new View instance which implements the UI for your installation node screen.

Called once when a new installation is loaded or created.

参数

  api_provider | Provides access to functionality and services available from within AuboScope related to user interface and end user interaction

返回
  the view

## ◆ getIcon()

virtual std::string arcs::aubo_scope::InstallationNodeService::getIcon | ( |  | ) |
| pure virtual

参数

  locale | the current locale of AuboScope. Can be used for supporting titles in several languages.

返回
  The text displayed for this installation contribution in the left-hand side navigation of the Installation Tab as well as the title of the corresponding installation node screen. Called once at start up.

## ◆ getTitle()

virtual std::string arcs::aubo_scope::InstallationNodeService::getTitle | ( |  | ) |
| pure virtual

参数

  locale | the current locale of AuboScope. Can be used for supporting titles in several languages.

返回
  The text displayed for this installation contribution in the left-hand side navigation of the Installation Tab as well as the title of the corresponding installation node screen. Called once at start up.

该类的文档由以下文件生成:

- include/aubo_caps/contribution/installation/installation_node_service.h