sapp-i.h

#ifndef __SAPP_I__H__
#define __SAPP_I__H__
#include <interface/obj-ref-i.h>
#include <interface/SResProvider-i.h>
#include <interface/STranslator-i.h>
#include <interface/stooltip-i.h>
#include <interface/slog-i.h>
#include <interface/SAttrStorage-i.h>
#include <interface/SMsgLoop-i.h>
#include <interface/shostwnd-i.h>
#include <interface/SResProviderMgr-i.h>
#include <interface/SRealWndHandler-i.h>
#include <interface/SRender-i.h>
#include <interface/SScriptModule-i.h>
#include <interface/SAnimation-i.h>
#include <interface/SValueAnimator-i.h>
#include <interface/SNotifyCenter-i.h>
#include <interface/SObjFactory-i.h>
#include <interface/SHostPresenter-i.h>
#include <interface/STaskLoop-i.h>
 
SNSBEGIN
 
typedef enum _SingletonType
{
    SINGLETON_UIDEF = 0,
    SINGLETON_SWNDMGR,
    SINGLETON_TIMERGENERATOR,
    SINGLETON_WINDOWFINDER,
    SINGLETON_RICHEDITMENUDEF,
    SINGLETON_HOSTMGR,
    SINGLETON_NOTIFYCENTER,
 
    SINGLETON_COUNT,
} SingletonType;
 
typedef struct IApplication IApplication;
typedef IObject *(*FunCreateObject)(const IApplication *app, LPCWSTR pszName, SObjectType nType);
typedef ITaskLoop *(*FunCrateTaskLoop)();
 
#undef INTERFACE
#define INTERFACE IApplication
DECLARE_INTERFACE_(IApplication, IObjRef)
{
    /**
     * @brief 添加引用
     * @return long -- 引用计数
     */
    STDMETHOD_(long, AddRef)(THIS) PURE;
 
    /**
     * @brief 释放引用
     * @return long -- 引用计数
     */
    STDMETHOD_(long, Release)(THIS) PURE;
 
    /**
     * @brief 释放对象
     * @return void
     */
    STDMETHOD_(void, OnFinalRelease)(THIS) PURE;
 
    //////////////////////////////////////////////////////////////////////////
 
    /**
     * @brief 获取当前app的hModule
     * @return HMODULE -- 当前app的hModule
     */
    STDMETHOD_(HMODULE, GetModule)(CTHIS) SCONST PURE;
 
    /**
     * @brief 从指定的ResProvider里加载系统资源
     * @param pResProvider IResProvider* -- 提供系统资源的资源包
     * @return UINT -- 0: 成功, 其它: 失败
     */
    STDMETHOD_(UINT, LoadSystemNamedResource)(THIS_ IResProvider * pResProvider) PURE;
 
    /**
     * @brief 获取翻译接口
     * @return ITranslatorMgr* -- 翻译接口
     */
    STDMETHOD_(ITranslatorMgr *, GetTranslator)(THIS) PURE;
 
    /**
     * @brief 设置翻译接口
     * @param pTrans ITranslatorMgr* -- 翻译接口
     * @return void
     */
    STDMETHOD_(void, SetTranslator)(THIS_ ITranslatorMgr * pTrans) PURE;
 
    /**
     * @brief 获取ToolTip类厂
     * @return IToolTipFactory* -- ToolTip类厂
     */
    STDMETHOD_(IToolTipFactory *, GetToolTipFactory)(THIS) PURE;
 
    /**
     * @brief 设置ToolTip类厂
     * @param pToolTipFac IToolTipFactory* -- ToolTip类厂
     * @return void
     */
    STDMETHOD_(void, SetToolTipFactory)(THIS_ IToolTipFactory * pToolTipFac) PURE;
 
    /**
     * @brief 设置MsgLoop类厂
     * @param pMsgLoopFac IMsgLoopFactory* -- MsgLoop类厂
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, SetMsgLoopFactory)(THIS_ IMsgLoopFactory * pMsgLoopFac) PURE;
 
    /**
     * @brief 获取当前的MsgLoop类厂
     * @return IMsgLoopFactory* -- MsgLoop类厂
     */
    STDMETHOD_(IMsgLoopFactory *, GetMsgLoopFactory)(THIS) PURE;
 
    /**
     * @brief 设置日志输出模块
     * @param pLogMgr ILogMgr* -- 日志输出模块
     * @return void
     */
    STDMETHOD_(void, SetLogManager)(THIS_ ILogMgr * pLogMgr) PURE;
 
    /**
     * @brief 获取日志输出模块
     * @return ILogMgr* -- 日志输出模块
     */
    STDMETHOD_(ILogMgr *, GetLogManager)(THIS) PURE;
 
    /**
     * @brief 设置属性持久化类厂
     * @param pAttrStorageFactory IAttrStorageFactory* -- 属性持久化类厂
     * @return void
     */
    STDMETHOD_(void, SetAttrStorageFactory)(THIS_ IAttrStorageFactory * pAttrStorageFactory) PURE;
 
    /**
     * @brief 获取属性持久化类厂
     * @return IAttrStorageFactory* -- 属性持久化类厂
     */
    STDMETHOD_(IAttrStorageFactory *, GetAttrStorageFactory)(THIS) PURE;
 
    /**
     * @brief 进入消息循环运行程序
     * @param hMainWnd HWND -- 主窗口句柄
     * @return int -- 程序退出的返回值
     */
    STDMETHOD_(int, Run)(THIS_ HWND hMainWnd) PURE;
 
    /**
     * @brief 退出消息循环
     * @param nCode int -- 线程退出代码
     * @return void
     */
    STDMETHOD_(void, Quit)(THIS_ int nCode) PURE;
 
    /**
     * @brief 获取程序主窗口
     * @return HWND -- 在Run方法中设定的窗口
     */
    STDMETHOD_(HWND, GetMainWnd)(THIS) PURE;
 
    /**
     * @brief 将当前UI线程的msgLoop保存到SApp中
     * @param pMsgLoop IMessageLoop* -- msgLoop
     * @param bReplace BOOL -- 替换标志
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, AddMsgLoop)(THIS_ IMessageLoop * pMsgLoop, BOOL bReplace DEF_VAL(FALSE)) PURE;
 
    /**
     * @brief 从SApp中删除当前线程的msgLoop
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, RemoveMsgLoop)(THIS) PURE;
 
    /**
     * @brief 获取指定UI线程的msgLoop
     * @param  tid -- 线程ID
     * @return IMessageLoop* -- 指定线程的msgLoop
     */
    STDMETHOD_(IMessageLoop *, GetMsgLoop)(CTHIS_ tid_t dwThreadID DEF_VAL(GetCurrentThreadId())) SCONST PURE;
 
    /**
     * @brief 获取IResProviderMgr接口
     * @return IResProviderMgr* -- IResProviderMgr接口
     */
    STDMETHOD_(IResProviderMgr *, GetResProviderMgr)(THIS) PURE;
 
    /**
     * @brief 获取RealWndHandler
     * @return IRealWndHandler* -- RealWndHandler
     */
    STDMETHOD_(IRealWndHandler *, GetRealWndHander)(THIS) PURE;
 
    /**
     * @brief 设置RealWnd处理接口
     * @param pRealHandler IRealWndHandler* -- RealWnd处理接口
     * @return void
     */
    STDMETHOD_(void, SetRealWndHandler)(THIS_ IRealWndHandler * pRealHandler) PURE;
 
    /**
     * @brief 获取当前的渲染模块
     * @return IRenderFactory* -- 渲染模块指针
     */
    STDMETHOD_(IRenderFactory *, GetRenderFactory)(THIS) PURE;
 
    /**
     * @brief 设置渲染模块
     * @param renderFac IRenderFactory* -- 渲染模块指针
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, SetRenderFactory)(THIS_ IRenderFactory * renderFac) PURE;
 
    /**
     * @brief 设置SOUI中使用的脚本模块类厂
     * @param pScriptModule IScriptFactory* -- 脚本模块类厂
     * @return void
     */
    STDMETHOD_(void, SetScriptFactory)(THIS_ IScriptFactory * pScriptModule) PURE;
 
    /**
     * @brief 初始化XML资源的name-id映射表
     * @param pNames const LPCWSTR* -- 控件名表
     * @param nIds const int* -- 控件ID表
     * @param nCount int -- 控件数量
     * @return void
     */
    STDMETHOD_(void, InitXmlNamedID)(THIS_ const LPCWSTR *pNames, const int *nIds, int nCount) PURE;
 
    /**
     * @brief 从资源ID加载XML
     * @param strResId LPCTSTR -- 资源ID，为type:name格式
     * @return IXmlDoc* -- XML Doc
     */
    STDMETHOD_(IXmlDoc *, LoadXmlDocment)(THIS_ LPCTSTR strResId) PURE;
    STDMETHOD_(IXmlDoc *, LoadXmlDocmentU8)(THIS_ LPCSTR strResId) PURE;
 
    /**
     * @brief 从资源加载动画资源
     * @param strResId LPCTSTR -- 动画资源ID
     * @return IAnimation* -- 动画对象
     */
    STDMETHOD_(IAnimation *, LoadAnimation)(THIS_ LPCTSTR strResId) PURE;
    STDMETHOD_(IAnimation *, LoadAnimationU8)(THIS_ LPCSTR strResId) PURE;
 
    /**
     * @brief 从资源加载数值动画资源
     * @param strResId LPCTSTR -- 动画资源ID
     * @return IValueAnimator* -- 数值动画对象
     */
    STDMETHOD_(IValueAnimator *, LoadValueAnimator)(THIS_ LPCTSTR strResId) PURE;
    STDMETHOD_(IValueAnimator *, LoadValueAnimatorU8)(THIS_ LPCSTR strResId) PURE;
 
    /**
     * @brief 从资源加载图片
     * @param strResId LPCTSTR -- 图片资源ID
     * @return IBitmapS* -- 图片对象
     */
    STDMETHOD_(IBitmapS *, LoadImage)(THIS_ LPCTSTR strResId) PURE;
    STDMETHOD_(IBitmapS *, LoadImageU8)(THIS_ LPCSTR strResId) PURE;
 
    /**
     * @brief 从资源加载翻译包
     * @param strResId LPCTSTR -- 翻译包资源ID
     * @return ITranslator* -- 翻译包对象
     */
    STDMETHOD_(ITranslator *, LoadTranslator)(THIS_ LPCTSTR strResId) PURE;
    STDMETHOD_(ITranslator *, LoadTranslatorU8)(THIS_ LPCSTR strResId) PURE;
 
    /**
     * @brief 使用翻译包
     * @param trModule ITranslator* -- 翻译包
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, InstallTranslator)(THIS_ ITranslator * trModule) PURE;
 
    /**
     * @brief 卸载翻译包
     * @param langId REFGUID -- 翻译包ID
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, UnnstallTranslator)(THIS_ REFGUID langId) PURE;
 
    /**
     * @brief 启用NotifyCenter
     * @param bEnable BOOL -- 是否启用
     * @param interval int -- 处理事件时间间隔
     * @return void
     */
    STDMETHOD_(void, EnableNotifyCenter)(THIS_ BOOL bEnable, int interval DEF_VAL(20)) PURE;
 
    /**
     * @brief 获取SApp内部定义的几个单例对象
     * @param type SingletonType -- 内部单例类型
     * @return void* -- 单例类型指针
     */
    STDMETHOD_(void *, GetInnerSingleton)(THIS_ SingletonType type) PURE;
 
    /**
     * @brief 创建对象
     * @param pszName LPCWSTR -- 类型在XML中的名字
     * @param nType SObjectType -- 类型ID
     * @return IObject* -- 创建的类型
     */
    STDMETHOD_(IObject *, CreateObject)(CTHIS_ LPCWSTR pszName, SObjectType nType) SCONST PURE;
 
    /**
     * @brief 设置CreateObject的回调
     * @param cbCreateObj FunCreateObject -- CreateObject的回调函数
     * @return void
     */
    STDMETHOD_(void, SetCreateObjectCallback)(THIS_ FunCreateObject cbCreateObj) PURE;
 
    /**
     * @brief 注册扩展对象
     * @param objFac const IObjectFactory* -- 对象类厂
     * @param bReplace BOOL -- 替换已有类厂标志
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, RegisterObjFactory)(THIS_ const IObjectFactory *objFac, BOOL bReplace DEF_VAL(FALSE)) PURE;
 
    /**
     * @brief 反注册扩展对象
     * @param objFac const IObjectFactory* -- 对象类厂
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, UnregisterObjFactory)(THIS_ const IObjectFactory *objFac) PURE;
 
    /**
     * @brief 设置默认字体
     * @param pszFontInfo LPCWSTR -- 字体描述，参考fontpool
     * @return void
     */
    STDMETHOD_(void, SetDefaultFontInfo)(THIS_ LPCWSTR pszFontInfo) PURE;
 
    /**
     * @brief 创建TaskLoop对象
     * @param nCount int -- taskloop对象数量
     * @param priority Priority -- taskloop的线程优先级
     * @param bAutoStart BOOL -- 自动启动标志
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, CreateTaskLoop)(THIS_ int nCount, Priority priority, BOOL bAutoStart DEF_VAL(TRUE)) PURE;
 
    /**
     * @brief 获取TaskLoop对象
     * @param iTaskLoop int -- taskloop索引
     * @return ITaskLoop* -- taskloop接口，失败返回NULL
     */
    STDMETHOD_(ITaskLoop *, GetTaskLoop)(THIS_ int iTaskLoop DEF_VAL(0)) PURE;
 
    /**
     * @brief 设置创建TaskLoop对象的回调接口
     * @param cbCreateTaskLoop FunCrateTaskLoop -- 创建TaskLoop对象的回调接口
     * @return void
     */
    STDMETHOD_(void, SetCreateTaskLoopCallback)(THIS_ FunCrateTaskLoop cbCreateTaskLoop) PURE;
 
    /**
     * @brief 创建脚本模块对象
     * @param ppScriptModule IScriptModule** -- 脚本模块对象
     * @return HRESULT -- S_OK: 创建成功
     */
    STDMETHOD_(HRESULT, CreateScriptModule)(THIS_ IScriptModule * *ppScriptModule) PURE;
 
    /**
     * @brief 设置编辑上下文菜单模板资源ID
     * @param resId LPCTSTR -- 资源ID
     * @param pResProvider IResProvider* -- 资源提供者
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, SetEditCtxMenuTemplateResId)(THIS_ LPCTSTR resId, IResProvider * pResProvider DEF_VAL(NULL)) PURE;
 
    /**
     * @brief 设置消息框模板资源ID
     * @param resId LPCTSTR -- 资源ID
     * @param pResProvider IResProvider* -- 资源提供者
     * @return BOOL -- TRUE: 成功
     */
    STDMETHOD_(BOOL, SetMessageBoxTemplateResId)(THIS_ LPCTSTR resId, IResProvider * pResProvider DEF_VAL(NULL)) PURE;
};
 
SNSEND
#endif // __SAPP_I__H__