NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
NXOpen::BlockStyler::Wizard类 参考

向导类 更多...

#include <BlockStyler_Wizard.hxx>

类 NXOpen::BlockStyler::Wizard 继承关系图:
NXOpen::BlockStyler::UIBlock NXOpen::TaggedObject

Public 类型

enum  DialogResponse {
  DialogResponseBack , DialogResponseNext , DialogResponseFinish , DialogResponseApply ,
  DialogResponseCancel
}
typedef NXOpen::Callback2< bool, NXOpen::BlockStyler::Wizard *, int > IsStepOkayCallback
typedef NXOpen::Callback4< void, NXOpen::BlockStyler::Wizard *, NXOpen::BlockStyler::Wizard::TaskNavigatorItem, int, int > OnMenuCallback
typedef NXOpen::Callback5< void, NXOpen::BlockStyler::Wizard *, NXOpen::BlockStyler::Wizard::TaskNavigatorItem, int, int, int > OnMenuSelectionCallback
typedef NXOpen::Callback4< void, NXOpen::BlockStyler::Wizard *, int, int, NXOpen::BlockStyler::Wizard::SubNodeActionOnSubNodeCallback
typedef NXOpen::Callback2< void, NXOpen::BlockStyler::Wizard *, int > StepNotifyPostCallback
typedef NXOpen::Callback2< int, NXOpen::BlockStyler::Wizard *, int > StepNotifyPreCallback
enum  SubNodeAction { SubNodeActionSelect , SubNodeActionDeselect , SubNodeActionCheck , SubNodeActionUncheck }
enum  TaskNavigatorItem { TaskNavigatorItemStep , TaskNavigatorItemSubNode , TaskNavigatorItemBackground }

Public 成员函数

NXOpen::BlockStyler::TreeListMenuCreateMenu ()
int CreateStepSubNode (int step, const char *text, const char *bitmap, bool showCheckBox, bool checkBoxChecked)
int CreateStepSubNode (int step, const NXString &text, const NXString &bitmap, bool showCheckBox, bool checkBoxChecked)
int CurrentStep ()
std::vector< NXStringGetStepBannerBitmaps ()
std::vector< NXStringGetStepBitmaps ()
std::vector< NXStringGetStepCues ()
std::vector< NXStringGetStepText ()
bool HighQualityBitmap ()
bool Localize ()
NXOpen::BlockStyler::PropertyListMembers ()
void RemoveStepSubNode (int subNodeId)
void SetCurrentStep (int currentStep)
void SetDialogNavigationResponse (NXOpen::BlockStyler::Wizard::DialogResponse response)
void SetHighQualityBitmap (bool highQuality)
void SetIsStepOkayHandler (const NXOpen::BlockStyler::Wizard::IsStepOkayCallback &cb)
void SetLocalize (bool localize)
void SetMenu (NXOpen::BlockStyler::TreeListMenu *menu)
void SetOnMenuHandler (const NXOpen::BlockStyler::Wizard::OnMenuCallback &cb)
void SetOnMenuSelectionHandler (const NXOpen::BlockStyler::Wizard::OnMenuSelectionCallback &cb)
void SetOnSubNodeHandler (const NXOpen::BlockStyler::Wizard::OnSubNodeCallback &cb)
void SetShowTaskNavigator (bool show)
void SetStepBannerBitmaps (std::vector< NXString > &bitmaps)
void SetStepBitmaps (std::vector< NXString > &bitmaps)
void SetStepCues (std::vector< NXString > &cues)
void SetStepNotifyPostHandler (const NXOpen::BlockStyler::Wizard::StepNotifyPostCallback &cb)
void SetStepNotifyPreHandler (const NXOpen::BlockStyler::Wizard::StepNotifyPreCallback &cb)
void SetStepText (std::vector< NXString > &text)
bool ShowTaskNavigator ()
void TestCurrentStepChanged (int currentStep)
void TestMenuAction (NXOpen::BlockStyler::Wizard::TaskNavigatorItem item, int stepNo, int subNodeId)
void TestMenuSelection (NXOpen::BlockStyler::Wizard::TaskNavigatorItem item, int stepNo, int subNodeId, int menuItemIndex)
void TestSubnodeAction (int stepNo, int subNodeId, NXOpen::BlockStyler::Wizard::SubNodeAction item)
Public 成员函数 继承自 NXOpen::BlockStyler::UIBlock
bool Enable ()
bool Expanded ()
void Focus ()
NXOpen::BlockStyler::PropertyListGetProperties ()
bool Group ()
NXString Label ()
NXString Name ()
void SetEnable (bool enable)
void SetExpanded (bool expanded)
void SetGroup (bool group)
void SetLabel (const char *label)
void SetLabel (const NXString &label)
void SetShow (bool show)
bool Show ()
void TestFocusChange ()
NXString Type ()
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _WizardBuilder

详细描述

向导类

表示向导控件
创建于NX7.5.0。

成员类型定义说明

◆ IsStepOkayCallback

IsStepOkay 回调允许客户端通知向导该步骤是否正常。 如果该步骤正常则返回 true,否则返回 false。回调的 step 参数是基于零的索引,表示向导中的步骤。
创建于NX7.5.0。

许可要求:无

◆ OnMenuCallback

OnMenu 回调在任务导航器中创建弹出菜单之前通知客户端。 item 参数指定弹出菜单是在步骤、子节点还是背景上激活的。回调的 step 参数是基于零的索引,表示向导中的步骤。 subNodeId 参数是由 BlockStyler::Wizard::CreateStepSubNode 返回的唯一ID。 如果弹出菜单是在任务导航器的背景上调用,则 step 和 subNodeId 参数将为 -1。
创建于NX7.5.0。

许可要求:无

◆ OnMenuSelectionCallback

OnMenuSelection 回调通知客户端在任务导航器的弹出菜单上选择了菜单项。 item 参数指定弹出菜单是在步骤、子节点还是背景上激活的。回调的 step 参数是基于零的索引,表示向导中的步骤。 subNodeId 参数是由 BlockStyler::Wizard::CreateStepSubNode 返回的唯一ID。menuItemIndex 参数将是 为 BlockStyler.TreeListMenu 创建菜单项时指定的唯一ID。 如果弹出菜单是在任务导航器的背景上调用,则 step 和 subNodeId 参数将为 -1。
创建于NX7.5.0。

许可要求:无

◆ OnSubNodeCallback

OnSubNode 回调通知客户端在向导任务导航器中对子节点执行的操作。 回调的 step 参数是基于零的索引,表示向导中的步骤。 subNodeId 参数是由 BlockStyler::Wizard::CreateStepSubNode 返回的唯一ID。
创建于NX7.5.0。

许可要求:无

◆ StepNotifyPostCallback

StepNotifyPost 回调在向导中导航到下一步之后通知客户端。 回调的 nextStep 参数是基于零的索引,表示向导中的步骤。
创建于NX7.5.0。

许可要求:无

◆ StepNotifyPreCallback

StepNotifyPre 回调在向导中导航到下一步之前通知客户端。 回调的 nextStep 参数是基于零的索引,表示向导中的步骤。
创建于NX7.5.0。

许可要求:无

成员枚举类型说明

◆ DialogResponse

表示基于按下的导航按钮的向导对话框响应值

枚举值
DialogResponseBack 

按下了“上一步”按钮。

DialogResponseNext 

按下了“下一步”按钮。

DialogResponseFinish 

按下了“完成”按钮。

DialogResponseApply 

按下了“应用”按钮。

DialogResponseCancel 

按下了“取消”按钮。

◆ SubNodeAction

指定在向导任务导航器中对子节点执行的操作类型。 该操作会传递给回调函数 BlockStyler.Wizard.OnSubNodeCallback。

枚举值
SubNodeActionSelect 

子节点已被选中。

SubNodeActionDeselect 

子节点已被取消选中。

SubNodeActionCheck 

如果指定了复选框,则子节点已被勾选。

SubNodeActionUncheck 

如果指定了复选框,则子节点已被取消勾选。

◆ TaskNavigatorItem

指定任务导航器中的项类型。

枚举值
TaskNavigatorItemStep 

步骤

TaskNavigatorItemSubNode 

子节点

TaskNavigatorItemBackground 

背景

成员函数说明

◆ CreateMenu()

NXOpen::BlockStyler::TreeListMenu * NXOpen::BlockStyler::Wizard::CreateMenu ( )

创建弹出菜单。使用 BlockStyler::Wizard::SetMenu 来设置创建的菜单。有关创建菜单的信息,请参阅 BlockStyler::TreeListMenu

返回

Created in NX7.5.0.

License requirements : None

◆ CreateStepSubNode() [1/2]

int NXOpen::BlockStyler::Wizard::CreateStepSubNode ( int step,
const char * text,
const char * bitmap,
bool showCheckBox,
bool checkBoxChecked )

在任务导航器中为步骤创建子节点。

返回
子节点的唯一标识符。
Created in NX7.5.0.

License requirements : None
参数
step要添加子节点的步骤。
text子节点的文本。
bitmap子节点的可选位图。
showCheckBox为子节点关联一个可选复选框。
checkBoxChecked复选框的初始状态。

◆ CreateStepSubNode() [2/2]

int NXOpen::BlockStyler::Wizard::CreateStepSubNode ( int step,
const NXString & text,
const NXString & bitmap,
bool showCheckBox,
bool checkBoxChecked )

在任务导航器中为步骤创建子节点。

返回
子节点的唯一标识符。
Created in NX7.5.0.

License requirements : None
参数
step要添加子节点的步骤。
text子节点的文本。
bitmap子节点的可选位图。
showCheckBox为子节点关联一个可选复选框。
checkBoxChecked复选框的初始状态。

◆ CurrentStep()

int NXOpen::BlockStyler::Wizard::CurrentStep ( )

返回 当前步骤。
Created in NX8.5.0.

License requirements : None

◆ GetStepBannerBitmaps()

std::vector< NXString > NXOpen::BlockStyler::Wizard::GetStepBannerBitmaps ( )

获取 StepBannerBitmaps。获取横幅区域中步骤位图的列表。
创建于 NX8.5.0。

许可要求:无

◆ GetStepBitmaps()

std::vector< NXString > NXOpen::BlockStyler::Wizard::GetStepBitmaps ( )

获取 StepBitmaps。获取任务导航器中节点位图的列表。
创建于 NX8.5.0。

许可要求:无

◆ GetStepCues()

std::vector< NXString > NXOpen::BlockStyler::Wizard::GetStepCues ( )

获取 StepCues。获取向导步骤的提示行列表。
创建于 NX8.5.0。

许可要求:无

◆ GetStepText()

std::vector< NXString > NXOpen::BlockStyler::Wizard::GetStepText ( )

获取 StepText。获取横幅区域的步骤描述列表。
创建于 NX8.5.0。

许可要求:无

◆ HighQualityBitmap()

bool NXOpen::BlockStyler::Wizard::HighQualityBitmap ( )

返回 HighQualityBitmap 属性。
创建于 NX8.5.0。

许可要求:无

◆ Localize()

bool NXOpen::BlockStyler::Wizard::Localize ( )

返回 Localize 属性。
创建于 NX8.5.0。

许可要求:无

◆ Members()

NXOpen::BlockStyler::PropertyList * NXOpen::BlockStyler::Wizard::Members ( )

返回 Members 属性。
创建于 NX8.5.0。

许可要求:无

◆ RemoveStepSubNode()

void NXOpen::BlockStyler::Wizard::RemoveStepSubNode ( int subNodeId)

移除任务导航器中的子节点。
Created in NX7.5.0.

License requirements : None

参数
subNodeId子节点标识符。

◆ SetCurrentStep()

void NXOpen::BlockStyler::Wizard::SetCurrentStep ( int currentStep)

设置 当前步骤。
Created in NX8.5.0.

License requirements : None

参数
currentStep当前步骤

◆ SetDialogNavigationResponse()

void NXOpen::BlockStyler::Wizard::SetDialogNavigationResponse ( NXOpen::BlockStyler::Wizard::DialogResponse response)

设置用于测试的对话框导航响应
创建于NX2306.0.0。

许可要求:nx_auto_test_studio("NX Automated Testing Studio")

参数
response响应

◆ SetHighQualityBitmap()

void NXOpen::BlockStyler::Wizard::SetHighQualityBitmap ( bool highQuality)

设置 HighQualityBitmap 属性。
创建于 NX8.5.0。

许可要求:无

参数
highQualityhighquality

◆ SetIsStepOkayHandler()

void NXOpen::BlockStyler::Wizard::SetIsStepOkayHandler ( const NXOpen::BlockStyler::Wizard::IsStepOkayCallback & cb)

设置 IsStepOkay 处理程序。
Created in NX7.5.0.

License requirements : None

参数
cb回调函数

◆ SetLocalize()

void NXOpen::BlockStyler::Wizard::SetLocalize ( bool localize)

设置 Localize 属性。
创建于 NX8.5.0。

许可要求:无

参数
localizelocalize

◆ SetMenu()

void NXOpen::BlockStyler::Wizard::SetMenu ( NXOpen::BlockStyler::TreeListMenu * menu)

为任务导航器中的步骤、子节点或背景设置弹出菜单的菜单项。有关创建菜单的信息,请参阅 BlockStyler::TreeListMenu
Created in NX7.5.0.

License requirements : None

参数
menu菜单

◆ SetOnMenuHandler()

void NXOpen::BlockStyler::Wizard::SetOnMenuHandler ( const NXOpen::BlockStyler::Wizard::OnMenuCallback & cb)

设置 OnMenu 处理程序。
Created in NX7.5.0.

License requirements : None

参数
cb回调函数

◆ SetOnMenuSelectionHandler()

void NXOpen::BlockStyler::Wizard::SetOnMenuSelectionHandler ( const NXOpen::BlockStyler::Wizard::OnMenuSelectionCallback & cb)

设置 OnMenuSelection 处理程序。
Created in NX7.5.0.

License requirements : None

参数
cb回调函数

◆ SetOnSubNodeHandler()

void NXOpen::BlockStyler::Wizard::SetOnSubNodeHandler ( const NXOpen::BlockStyler::Wizard::OnSubNodeCallback & cb)

设置 OnSubNode 处理程序。
Created in NX7.5.0.

License requirements : None

参数
cb回调函数

◆ SetShowTaskNavigator()

void NXOpen::BlockStyler::Wizard::SetShowTaskNavigator ( bool show)

设置 ShowTaskNavigator 属性。
创建于 NX8.5.0。

许可要求:无

参数
showshow

◆ SetStepBannerBitmaps()

void NXOpen::BlockStyler::Wizard::SetStepBannerBitmaps ( std::vector< NXString > & bitmaps)

设置 StepBannerBitmaps。设置横幅区域中步骤位图的列表。
创建于 NX8.5.0。

许可要求:无

参数
bitmapsbitmaps

◆ SetStepBitmaps()

void NXOpen::BlockStyler::Wizard::SetStepBitmaps ( std::vector< NXString > & bitmaps)

设置 StepBitmaps。设置任务导航器中节点位图的列表。
创建于 NX8.5.0。

许可要求:无

参数
bitmapsbitmaps

◆ SetStepCues()

void NXOpen::BlockStyler::Wizard::SetStepCues ( std::vector< NXString > & cues)

设置 StepCues。设置向导步骤的提示行列表。
创建于 NX8.5.0。

许可要求:无

参数
cuescues

◆ SetStepNotifyPostHandler()

void NXOpen::BlockStyler::Wizard::SetStepNotifyPostHandler ( const NXOpen::BlockStyler::Wizard::StepNotifyPostCallback & cb)

设置 StepNotifyPost 处理程序。
Created in NX7.5.0.

License requirements : None

参数
cb回调函数

◆ SetStepNotifyPreHandler()

void NXOpen::BlockStyler::Wizard::SetStepNotifyPreHandler ( const NXOpen::BlockStyler::Wizard::StepNotifyPreCallback & cb)

设置 StepNotifyPre 处理程序。
Created in NX7.5.0.

License requirements : None

参数
cb回调函数

◆ SetStepText()

void NXOpen::BlockStyler::Wizard::SetStepText ( std::vector< NXString > & text)

设置 StepText。设置横幅区域的步骤描述列表。
创建于 NX8.5.0。

许可要求:无

参数
texttext

◆ ShowTaskNavigator()

bool NXOpen::BlockStyler::Wizard::ShowTaskNavigator ( )

返回 ShowTaskNavigator 属性。
创建于 NX8.5.0。

许可要求:无

◆ TestCurrentStepChanged()

void NXOpen::BlockStyler::Wizard::TestCurrentStepChanged ( int currentStep)

测试设置当前步骤。
创建于 NX2206.0.0。

许可要求:nx_auto_test_studio("NX Automated Testing Studio")

参数
currentStepcurrentstep

◆ TestMenuAction()

void NXOpen::BlockStyler::Wizard::TestMenuAction ( NXOpen::BlockStyler::Wizard::TaskNavigatorItem item,
int stepNo,
int subNodeId )

测试映射到此块的菜单操作。
创建于NX2206.0.0。

许可要求:nx_auto_test_studio("NX Automated Testing Studio")

参数
item
stepNo步骤编号
subNodeId子节点ID

◆ TestMenuSelection()

void NXOpen::BlockStyler::Wizard::TestMenuSelection ( NXOpen::BlockStyler::Wizard::TaskNavigatorItem item,
int stepNo,
int subNodeId,
int menuItemIndex )

测试映射到此块的菜单选择。
创建于NX2206.0.0。

许可要求:nx_auto_test_studio("NX Automated Testing Studio")

参数
item
stepNo步骤编号
subNodeId子节点ID
menuItemIndex菜单项索引

◆ TestSubnodeAction()

void NXOpen::BlockStyler::Wizard::TestSubnodeAction ( int stepNo,
int subNodeId,
NXOpen::BlockStyler::Wizard::SubNodeAction item )

测试映射到此块的子节点操作。
创建于NX2206.0.0。

许可要求:nx_auto_test_studio("NX Automated Testing Studio")

参数
stepNo步骤编号
subNodeId子节点ID
item