ICommand(IMainFrame * mf) :m_bScript(false), m_pFrm(mf)
| 原型 | ICommand(IMainFrame * mf) :m_bScript(false), m_pFrm(mf) |
| 描述 | 构造函数 |
| 参数 | [i]IMainFrame * mf: 主框架指针 |
| 返回值 | 无 |
void invalidate()
| 原型 | void invalidate() |
| 描述 | 使命令失效 |
| 参数 | 无 |
| 返回值 | 无 |
void setScriptMode(bool b)
| 原型 | void setScriptMode(bool b) |
| 描述 | 设置脚本模式 |
| 参数 | [i]bool b: 是否启动脚本模式 |
| 返回值 | 无 |
bool isValid() const
| 原型 | bool isValid() const |
| 描述 | 命令是否可用 |
| 参数 | 无 |
| 返回值 | 如文档为空或主框架为空，返回false；否则返回true |
bool isDocumentReady()
| 原型 | bool isDocumentReady() |
| 描述 | 判断命令的文档指针是否可用 |
| 参数 | 无 |
| 返回值 | 若文档为空，返回false；否则返回true |
XDocument * getDocument()
| 原型 | XDocument * getDocument() |
| 描述 | 获取命令的文档指针 |
| 参数 | 无 |
| 返回值 | 命令的文档指针 |
virtual void initWindow()
| 原型 | virtual void initWindow() |
| 描述 | 初始化命令的对话框窗口 |
| 参数 | 无 |
| 返回值 | 无 |
virtual void onDataExchange(const char * dxdialog = NULL)
| 原型 | virtual void onDataExchange(const char * dxdialog = NULL) |
| 描述 | 交换内存参数与界面控件状态值 |
| 参数 | [i]const char * dxdialog = NULL: 指定交换的子窗口名，若为空则交换主窗口的控件值 |
| 返回值 | 无 |
virtual void exchangeScript(ParamList * param)
| 原型 | virtual void exchangeScript(ParamList * param) |
| 描述 | 交换内存参数与脚本参数值 |
| 参数 | [i]ParamList * param: 脚本参数对象指针 |
| 返回值 | 无 |
virtual void updateData(bool bSaveValidate = true)
| 原型 | virtual void updateData(bool bSaveValidate = true) |
| 描述 | 交换内存参数与界面控件状态值 |
| 参数 | [i]bool bSaveValidate = true: 为真将界面状态值更新到内存参数中，否则将内存参数更新到界面控件中 |
| 返回值 | 无 |
void updateToDialog()
| 原型 | void updateToDialog() |
| 描述 | 将内存参数值更新到界面控件中 |
| 参数 | 无 |
| 返回值 | 无 |
void updateFromDialog()
| 原型 | void updateFromDialog() |
| 描述 | 将界面控件的状态值更新到内存参数中 |
| 参数 | 无 |
| 返回值 | 无 |
virtual void updateControl(const char * configStr)
| 原型 | virtual void updateControl(const char * configStr) |
| 描述 | 更新控件状态 |
| 参数 | [i]const char * configStr: 控件名 |
| 返回值 | 无 |
virtual void onControlEvent(const char * ctrlName, TypeID event = Event_Any)
| 原型 | virtual void onControlEvent(const char * ctrlName, TypeID event = Event_Any) |
| 描述 | 响应控件的交互事件 |
| 参数 | [i]const char * ctrlName:发生交互事件的控件名 [i] TypeID event = Event_Any: 事件类型，默认为任何交互事件类型 |
| 返回值 | 无 |
virtual void onPickChanged()
| 原型 | virtual void onPickChanged() |
| 描述 | 当用户选择对象时更新对话框 |
| 参数 | 无 |
| 返回值 | 无 |
virtual void onViewChanged()
| 原型 | virtual void onViewChanged() |
| 描述 | 当视图变化时更新对话框 |
| 参数 | 无 |
| 返回值 |
virtual ErrorCode execute()
| 原型 | virtual ErrorCode execute() |
| 描述 | 执行命令 |
| 参数 | 无 |
| 返回值 | 成本执行返回0，否则返回对应错误码 |
virtual const char * getUISettingXml()
| 原型 | virtual const char * getUISettingXml() |
| 描述 | 获取命令对话框的文本配置文件路径 |
| 参数 | 无 |
| 返回值 | 文本配置文件路径字符串 |
virtual void setParam(const CmdParam * param)
| 原型 | virtual void setParam(const CmdParam * param) |
| 描述 | 设置命令的参数 |
| 参数 | [i]const CmdParam * param: 命令参数结构体指针 |
| 返回值 | 无 |
virtual bool setContextParam(const TreeNode * targetNode, const TreeNode * fromNode = 0)
| 原型 | virtual bool setContextParam(const TreeNode * targetNode, const TreeNode * fromNode = 0) |
| 描述 | 通过模型树右键菜单设置命令参数 |
| 参数 | [i]const TreeNode * targetNode: 右键点击的模型树节点 [i] const TreeNode * fromNode = 0: 辅助模型树节点，一般在拷贝、拖拽时用于指定源节点 |
| 返回值 | 如targetNode与命令匹配，返回true；否则返回false |
virtual void setTarget(vector<const XItem *> * tars, int role = 0)
| 原型 | virtual void setTarget(vector<const XItem *> * tars, int role = 0) |
| 描述 | 设置命令的应用对象 |
| 参数 | [i]vector<const XItem *> * tars: 应用对象数组 [i] int role = 0: 对象的角色 |
| 返回值 | 无 |
virtual CmdParam * getParam()
| 原型 | virtual CmdParam * getParam() |
| 描述 | 返回命令参数指针 |
| 参数 | 无 |
| 返回值 | 命令参数指针 |
virtual CommandType getType() = 0
| 原型 | virtual CommandType getType() = 0 |
| 描述 | 返回命令的类型 |
| 参数 | 无 |
| 返回值 | 命令类型ID |
virtual const char * getName() const = 0
| 原型 | virtual const char * getName() const = 0 |
| 描述 | 返回命令的名称 |
| 参数 | 无 |
| 返回值 | 命令名字符串 |
ulong getId() const
| 原型 | ulong getId() const |
| 描述 | 返回命令的ID |
| 参数 | 无 |
| 返回值 | 命令ID |
void setIndex(const CommandIndex * idx)
| 原型 | void setIndex(const CommandIndex * idx) |
| 描述 | 设置命令的索引 |
| 参数 | [i]const CommandIndex * idx: 索引指针 |
| 返回值 | 无 |
const CommandIndex * index() const
| 原型 | const CommandIndex * index() const |
| 描述 | 返回命令的索引 |
| 参数 | 无 |
| 返回值 | 索引指针 |
virtual const char * getHint()
| 原型 | virtual const char * getHint() |
| 描述 | 返回命令的提示 |
| 参数 | 无 |
| 返回值 | 提示字符串 |
virtual bool checkContext()
| 原型 | virtual bool checkContext() |
| 描述 | 检查命令参数与选择的对象是否满足执行命令的条件 |
| 参数 | 无 |
| 返回值 | 若满足命令执行返回真，否则返回false |
virtual void updateFrame()
| 原型 | virtual void updateFrame() |
| 描述 | 当成功执行命令时更新框架 |
| 参数 | 无 |
| 返回值 | 无 |
virtual void getActionSetting(string * setting)
| 原型 | virtual void getActionSetting(string * setting) |
| 描述 | 当命令为状态命令时，获取当前状态的格式字符串 |
| 参数 | [i]string * setting: 状态格式字符串 |
| 返回值 | 无 |
virtual void updateParam()
| 原型 | virtual void updateParam() |
| 描述 | 在成功执行之后更新命令参数 |
| 参数 | 无 |
| 返回值 | 无 |
virtual ~ICommand()
| 原型 | virtual ~ICommand() |
| 描述 | 析构函数 |
| 参数 | 无 |
| 返回值 | 无 |
