MB标准版API文档

珠海独角兽科技有限公司



unsigned int wkeGetVersion()

【说明】:获取webView的API版本号。

【参数】:略。。。


const utf8* wkeGetVersionString()

【说明】:获取webView常规版本号。

【参数】:略。。。


unsigned int wkeVersion()

【说明】:同wkeGetVersion。

【参数】:略。。。


const utf8* wkeVersionString()

【说明】:同wkeGetVersionString。

【参数】:略。。。


const char* wkeWebViewName(wkeWebView webView)

【说明】:获取通过wkeSetWebViewName设置的webView的内置名称。

【参数】:略。。。


void wkeSetWebViewName(wkeWebView webView, const char* name)

【说明】:设置webView内置名称,基本没啥用。

【参数】:略。。。


const char* wkeGetName(wkeWebView webView)

【说明】:同wkeWebViewName。

【参数】:略。。。


void wkeSetName(wkeWebView webView, const char* name)

【说明】:同wkeSetWebViewName。

【参数】:略。。。


const utf8* wkeGetTitle(wkeWebView webView)

【说明】:获取网页标题。

【参数】:略。。。


const wchar_t* wkeGetTitleW(wkeWebView webView)

【说明】:宽字符版wkeGetTitle。

【参数】:略。。。


const utf8* wkeTitle(wkeWebView webView)

【说明】:同wkeGetTitle。

【参数】:略。。。


const wchar_t* wkeTitleW(wkeWebView webView)

【说明】:同wkeGetTitleW。

【参数】:略。。。


const utf8* wkeGetString(const wkeString string)

【说明】:获取wkeString结构体对应的字符串,wkeString定义可参考wke.h文件,wkeString可理解为webView内部的一个公共缓存,可存放内部数据,如标题、url等,也可通过wkeSetString接口自行设置。

【参数】:略。。。


const wchar_t* wkeGetStringW(const wkeString string)

【说明】:宽字符版wkeGetString。

【参数】:略。。。


const utf8* wkeToString(const wkeString string)

【说明】:设置wkeString结构体对应的字符串,参看wkeGetString。

【参数】:略。。。


const wchar_t* wkeToStringW(const wkeString string)

【说明】:宽字符版wkeToString。

【参数】:略。。。


void wkeSetString(wkeString string, const utf8* str, size_t len)

【说明】:设置wkeString结构体对应的字符串,wkeString定义可参考wke.h文件。

【参数】:略。。。


void wkeSetStringWithoutNullTermination(wkeString string, const utf8* str, size_t len)

【说明】:同wkeSetString。

【参数】:略。。。


void wkeSetStringW(wkeString string, const wchar_t* str, size_t len)

【说明】:宽字符版wkeSetString。

【参数】:略。。。


wkeString wkeCreateString(const utf8* str, size_t len)

【说明】:创建一个wkeString字符串,wkeString定义可参考wke.h文件。

【参数】:略。。。


wkeString wkeCreateStringW(const wchar_t* str, size_t len)

【说明】:宽字符版wkeCreateString。

【参数】:略。。。


wkeString wkeCreateStringWithoutNullTermination(const utf8* str, size_t len)

【说明】:同wkeCreateString。

【参数】:略。。。


size_t wkeGetStringLen(wkeString str)

【说明】:获取wkeString字符串长度。

【参数】:略。。。


void wkeDeleteString(wkeString str)

【说明】:干掉wkeString字符串,释放其内存。

【参数】:略。。。


void wkeGC(wkeWebView webView, long intervalSec)

【说明】:设置自动释放内存时间间隔,#intervalSec:单位秒,默认300秒。

【参数】:intervalSec:单位秒,默认300秒。


void wkeSetResourceGc(wkeWebView webView, long intervalSec)

【说明】:设置自动释放系统资源时间间隔,#intervalSec:单位秒,默认300秒。

【参数】:intervalSec:单位秒,默认300秒。


void wkeEditorSelectAll(wkeWebView webView)

【说明】:全选。

【参数】:略。。。


void wkeEditorUnSelect(wkeWebView webView)

【说明】:反选。

【参数】:略。。。


void wkeEditorCopy(wkeWebView webView)

【说明】:拷贝页面里被选中的字符串。

【参数】:略。。。


void wkeEditorCut(wkeWebView webView)

【说明】:剪切页面里被选中的字符串。

【参数】:略。。。


void wkeEditorPaste(wkeWebView webView)

【说明】:复制页面里被选中的字符串。

【参数】:略。。。


void wkeEditorDelete(wkeWebView webView)

【说明】:删除页面里被选中的字符串。

【参数】:略。。。


void wkeEditorUndo(wkeWebView webView)

【说明】:撤销上次的操作。

【参数】:略。。。


void wkeEditorRedo(wkeWebView webView)

【说明】:重做上次的操作。

【参数】:略。。。


void wkeSelectAll(wkeWebView webView)

【说明】:同wkeEditorSelectAll。

【参数】:略。。。


void wkeCopy(wkeWebView webView)

【说明】:同wkeEditorCopy。

【参数】:略。。。


void wkeCut(wkeWebView webView)

【说明】:同wkeEditorCut。

【参数】:略。。。


void wkePaste(wkeWebView webView)

【说明】:同wkeEditorPaste。

【参数】:略。。。


void wkeDelete(wkeWebView webView)

【说明】:同wkeEditorDelete。

【参数】:略。。。


void wkeUpdate()

【说明】:刷新。

【参数】:略。。。


void wkeConfigure(const wkeSettings* settings)

【说明】:设置一些配置项,#settings:参看wke.h文件。

【参数】:settings:参看wke.h文件。


void wkeShutdownForDebug()

【说明】:内部测试使用。

【参数】:略。。。


BOOL wkeIsInitialize()

【说明】:webView是否已初始化。

【参数】:略。。。


void wkeSetViewSettings(wkeWebView webView, const wkeViewSettings* settings)

【说明】:设置一些webview相关的设置,目前只有背景颜色可以设置。

【参数】:略。。。


void wkeSetDebugConfig(wkeWebView webView, const char* debugString, const char* param)

【说明】:设置一些实验性选项,#debugString:showDevTools:开启开发者工具,此时param要填写开发者工具的资源路径,如file:///c:/miniblink-release/front_end/inspector.html,param此时必须是ASCII编码。wakeMinInterval:设置帧率,默认值是10,值越大帧率越低。drawMinInterval:设置帧率,默认值是3,值越大帧率越低。antiAlias:设置抗锯齿渲染,param必须设置为“1”。minimumFontSize:最小字体。minimumLogicalFontSize:最小逻辑字体。defaultFontSize:默认字号。defaultFixedFontSize:默认Fixed字号。imageEnable:是否打开无图模式,param为“0”表示开启无图模式。jsEnable:是否禁用js,param为“0”表示禁用。

【参数】:debugString:showDevTools:开启开发者工具,此时param要填写开发者工具的资源路径,如file:///c:/miniblink-release/front_end/inspector.html,param此时必须是ASCII编码。wakeMinInterval:设置帧率,默认值是10,值越大帧率越低。drawMinInterval:设置帧率,默认值是3,值越大帧率越低。antiAlias:设置抗锯齿渲染,param必须设置为“1”。minimumFontSize:最小字体。minimumLogicalFontSize:最小逻辑字体。defaultFontSize:默认字号。defaultFixedFontSize:默认Fixed字号。imageEnable:是否打开无图模式,param为“0”表示开启无图模式。jsEnable:是否禁用js,param为“0”表示禁用。


void * wkeGetDebugConfig(wkeWebView webView, const char* debugString)

【说明】:获取调试选项,参看wkeSetDebugConfig。

【参数】:略。。。


wkeWebView wkeCreateWebView()

【说明】:在内存里创建一个webView对象,但不创建真窗口,一般用在离屏渲染里,如游戏等。

【参数】:略。。。


void wkeDestroyWebView(wkeWebView webView)

【说明】:干掉webView,释放其内存。

【参数】:略。。。


void wkeSetMemoryCacheEnable(wkeWebView webView, bool b)

【说明】:设置是否开启内存缓存,默认开。开启后图片等都会放到内存缓存里,用于某些优化操作。关闭则会降低内存使用,但容易引起一些问题。

【参数】:略。。。


void wkeSetMouseEnabled(wkeWebView webView, bool b)

【说明】:设置是否允许鼠标,默认开。

【参数】:略。。。


void wkeSetTouchEnabled(wkeWebView webView, bool b)

【说明】:设置是否允许触屏,默认关。开启后,鼠标消息将自动转换成触屏消息。

【参数】:略。。。


void wkeSetSystemTouchEnabled(wkeWebView webView, bool b)

【说明】:设置操作系统是否发送触屏消息。

【参数】:略。。。


void wkeSetContextMenuEnabled(wkeWebView webView, bool b)

【说明】:设置是否允许菜单,默认开。

【参数】:略。。。


void wkeSetNavigationToNewWindowEnable(wkeWebView webView, bool b)

【说明】:设置页面内链接点击后是否跳转新窗口,默认关,如开启,则会触发wkeOnCreateView回调接口。

【参数】:略。。。


void wkeSetCspCheckEnable(wkeWebView webView, bool b)

【说明】:设置是否开启csp跨域检查,默认开。如需进行跨域操作,如跨域ajax,跨域设置iframe等,则需要先关闭此开关。

【参数】:略。。。


void wkeSetNpapiPluginsEnabled(wkeWebView webView, bool b)

【说明】:设置是否开启npapi插件,如flash等,默认关。

【参数】:略。。。


void wkeSetHeadlessEnabled(wkeWebView webView, bool b)

【说明】:开启无头模式,默认关。开启后页面不会被渲染上屏,直接内存运行,大幅提升性能。此功能方便用来实现一些爬虫等工具,不过目前很多网站对这种模式已经进行了识别和反制。

【参数】:略。。。


void wkeSetDragEnable(wkeWebView webView, bool b)

【说明】:设置是否允许拖拽文件,默认关。

【参数】:略。。。


void wkeSetDragDropEnable(wkeWebView webView, bool b)

【说明】:设置是否允许拖拽到其他程序窗口,默认关。

【参数】:略。。。


void wkeSetContextMenuItemShow(wkeWebView webView, wkeMenuItemId item, bool isShow)

【说明】:设置指定的菜单项是否显示。#item:枚举结构请参看wke.h文件。

【参数】:item:枚举结构请参看wke.h文件。


void wkeSetLanguage(wkeWebView webView, const char* language)

【说明】:设置其他语言,默认跟随系统设定。

【参数】:略。。。


void wkeSetProxy(const wkeProxy* proxy)

【说明】:设置webView代理,全局生效,#proxy:参看wke.h文件。

【参数】:proxy:参看wke.h文件。


void wkeSetViewProxy(wkeWebView webView, wkeProxy *proxy)

【说明】:设置webView代理,设计是针对特定webView生效,不过目前也是全局的,没空改,#proxy:参看wke.h文件。

【参数】:proxy:参看wke.h文件。


HWND wkeGetWindowHandle(wkeWebView webWindow)

【说明】:获取webWindow句柄。

【参数】:略。。。


void wkeSetClientHandler(wkeWebView webView, const wkeClientHandler* handler)

【说明】:设置webView句柄。

【参数】:略。。。


const wkeClientHandler* wkeGetClientHandler(wkeWebView webView)

【说明】:获取webView句柄。

【参数】:略。。。


void wkeSetHandle(wkeWebView webView, HWND wnd)

【说明】:设置wkeWebView对应的窗口句柄,无头模式时使用的,如果是wkeCreateWebWindow创建的webview,已经自带窗口句柄了。

【参数】:略。。。


void wkeSetHandleOffset(wkeWebView webView, int x, int y)

【说明】:设置无头模式下的绘制位置。如在某些情况下绘制的地方不在真窗口的(0,0)处,就需要手动调用此接口。

【参数】:略。。。


BOOL wkeIsTransparent(wkeWebView webView)

【说明】:判断窗口是否是透明模式。

【参数】:略。。。


void wkeSetTransparent(wkeWebView webView, bool transparent)

【说明】:设置是否开启透明模式。

【参数】:略。。。


const utf8* wkeGetSource(wkeWebView webView)

【说明】:获取网页H5源码。

【参数】:略。。。


void wkeSetUserAgent(wkeWebView webView, const utf8* userAgent)

【说明】:设置webview的UA。

【参数】:略。。。


void wkeSetUserAgentW(wkeWebView webView, const wchar_t* userAgent)

【说明】:宽字符版wkeSetUserAgent。

【参数】:略。。。


const char* wkeGetUserAgent(wkeWebView webView)

【说明】:获取webview的UA

【参数】:略。。。


void wkeLoadW(wkeWebView webView, const wchar_t* url)

【说明】:同wkeLoadURLW。

【参数】:略。。。


void wkeLoadURL(wkeWebView webView, const utf8* url)

【说明】:加载网址,建议写完整url,如:http://www.miniblink.net 。

【参数】:略。。。


void wkeLoadURLW(wkeWebView webView, const wchar_t* url)

【说明】:宽字符版wkeLoadURL。

【参数】:略。。。


void wkePostURL(wkeWebView wkeView, const utf8* url, const char* postData, int postLen)

【说明】:POST网络请求。

【参数】:略。。。


void wkePostURLW(wkeWebView wkeView, const wchar_t* url, const char* postData, int postLen)

【说明】:宽字符版wkePostURL。

【参数】:略。。。


void wkeLoadHTML(wkeWebView webView, const utf8* html)

【说明】:加载一段H5代码,注意:如果代码里有相对路径的文件操作,则是相对exe所在的路径。

【参数】:略。。。


void wkeLoadHTMLW(wkeWebView webView, const wchar_t* html)

【说明】:宽字符版wkeLoadHTML。

【参数】:略。。。


void wkeLoadHtmlWithBaseUrl(wkeWebView webView, const utf8* html, const utf8* baseUrl)

【说明】:同wkeLoadHTML,但可以指定相对于哪个目录。

【参数】:略。。。


void wkeLoadFile(wkeWebView webView, const utf8* filename)

【说明】:加载文件到webView的内存,一般没啥用。

【参数】:略。。。


void wkeLoadFileW(wkeWebView webView, const wchar_t* filename)

【说明】:宽字符版wkeLoadFile。

【参数】:略。。。


const utf8* wkeGetURL(wkeWebView webView)

【说明】:获取主frame的url。

【参数】:略。。。


const utf8* wkeGetFrameUrl(wkeWebView webView, wkeWebFrameHandle frameId)

【说明】:获取指定frame的url。

【参数】:略。。。


BOOL wkeIsLoading(wkeWebView webView)

【说明】:判断webView是否正在加载。

【参数】:略。。。


BOOL wkeIsLoadingFailed(wkeWebView webView)

【说明】:判断webView是否加载失败。

【参数】:略。。。


BOOL wkeIsLoadingCompleted(wkeWebView webView)

【说明】:判断webView是否加载完成。

【参数】:略。。。


BOOL wkeIsDocumentReady(wkeWebView webView)

【说明】:DOM文档结构是否加载完成。注意:即使返回加载完成也不等于网页加载一定完成,因为现在网页普遍使用异步加载技术。

【参数】:略。。。


void wkeStopLoading(wkeWebView webView)

【说明】:停止加载当前页面。

【参数】:略。。。


void wkeReload(wkeWebView webView)

【说明】:重新加载当前页面,从服务器重新拉取内容而不仅仅是重新渲染,相当于按ctrl+F5强刷。

【参数】:略。。。


void wkeGoToOffset(wkeWebView webView, int offset)

【说明】:移动到指定偏移位置,一般没啥用。

【参数】:略。。。


void wkeGoToIndex(wkeWebView webView, int index)

【说明】:移动到指定索引位置,一般没啥用。

【参数】:略。。。


const utf8* wkeGetDocumentCompleteURL(wkeWebView webView, wkeWebFrameHandle frameId, const utf8* partialURL)

【说明】:获取完整的url。

【参数】:略。。。


wkeMemBuf* wkeCreateMemBuf(wkeWebView webView, void* buf, size_t length)

【说明】:new一块内存空间。

【参数】:略。。。


void wkeFreeMemBuf(wkeMemBuf* buf)

【说明】:释放内存。

【参数】:略。。。


void wkeResize(wkeWebView webView, int w, int h)

【说明】:重新设置页面的像素宽高,如果webView是带窗口模式的,会设置实际窗口的宽高。

【参数】:略。。。


int wkeGetWidth(wkeWebView webView)

【说明】:获取webView宽度像素,同wkeWidth。

【参数】:略。。。


int wkeGetHeight(wkeWebView webView)

【说明】:获取webView高度像素,同wkeHeight。

【参数】:略。。。


int wkeGetContentWidth(wkeWebView webView)

【说明】:获取webView排版出来的内容区域宽度像素。

【参数】:略。。。


int wkeGetContentHeight(wkeWebView webView)

【说明】:获取webView排版出来的内容区域高度像素。

【参数】:略。。。


int wkeWidth(wkeWebView webView)

【说明】:同wkeGetWidth。

【参数】:略。。。


int wkeHeight(wkeWebView webView)

【说明】:同wkeGetHeight。

【参数】:略。。。


int wkeContentsWidth(wkeWebView webView)

【说明】:同wkeGetContentWidth。

【参数】:略。。。


int wkeContentsHeight(wkeWebView webView)

【说明】:同wkeGetContentHeight。

【参数】:略。。。


void wkePaint2(wkeWebView webView, void* bits, int bufWid, int bufHei, int xDst, int yDst, int w, int h, int xSrc, int ySrc, bool bCopyAlpha)

【说明】:获取页面像素,一般给3D游戏使用,频繁使用此接口并拷贝像素会有性能问题,建议先用wkeGetViewDC再去拷贝DC,#bits:传递给webView的buffer,大小是bufWid*bufHei*4字节,#bufWid:bits的宽,#bufHei:bits的高,#xDst:绘制到bits的哪个坐标,#yDst:绘制到bits的哪个坐标,#w:webView需要取的画面的宽度,#h:webView需要取的画面的高度,#xSrc:webView需要取的画面的起始x坐标,#ySrc:webView需要取的画面的起始y坐标,#bCopyAlpha:是否拷贝画面的透明度值。

【参数】:bits:传递给webView的buffer,大小是bufWid*bufHei*4字节,
                 bufWid:bits的宽,
                 bufHei:bits的高,
                 xDst:绘制到bits的哪个坐标,
                 yDst:绘制到bits的哪个坐标,
                 w:webView需要取的画面的宽度,
                 h:webView需要取的画面的高度,
                 xSrc:webView需要取的画面的起始x坐标,
                 ySrc:webView需要取的画面的起始y坐标,
                 bCopyAlpha:是否拷贝画面的透明度值。


void wkePaint(wkeWebView webView, void* bits, int pitch)

【说明】:获取页面像素的简化版,#bits:传递给webView的buffer,大小是webview宽度*高度*4字节,#pitch:填0。

【参数】:bits:传递给webView的buffer,大小是webview宽度*高度*4字节,
                 pitch:填0。


HDC wkeGetViewDC(wkeWebView webView)

【说明】:获取webview的DC。

【参数】:略。。。


void wkeUnlockViewDC(wkeWebView webView)

【说明】:解锁webview的DC。

【参数】:略。。。


HWND wkeGetHostHWND(wkeWebView webView)

【说明】:获取webveiw对应的窗口句柄,同wkeGetWindowHandle。

【参数】:略。。。


BOOL wkeCanGoBack(wkeWebView webView)

【说明】:判断页面是否可以后退。

【参数】:略。。。


BOOL wkeGoBack(wkeWebView webView)

【说明】:强制让页面后退。

【参数】:略。。。


BOOL wkeCanGoForward(wkeWebView webView)

【说明】:判断页面是否可以前进。

【参数】:略。。。


BOOL wkeGoForward(wkeWebView webView)

【说明】:强制让页面前进。

【参数】:略。。。


BOOL wkeCookieEnabled(wkeWebView webView)

【说明】:判断Cookie是否启用。

【参数】:略。。。


const utf8* wkeGetCookie(wkeWebView webView)

【说明】:获取页面的cookie字符串。

【参数】:略。。。


const wchar_t* wkeGetCookieW(wkeWebView webView)

【说明】:宽字符版wkeGetCookie。

【参数】:略。。。


void wkeSetCookie(wkeWebView webView, const utf8* url, const utf8* cookie)

【说明】:设置页面的cookie,须符合curl的cookie格式要求,否则无效。

【参数】:略。。。


void wkeVisitAllCookie(wkeWebView webView, void* params, wkeCookieVisitor visitor)

【说明】:通过访问器visitor访问所有cookie,#params:自定义参数,没有传NULL,#visitor:是个回调,具体定义参看wke.h文件。

【参数】:params:自定义参数,没有传NULL,
                 visitor:是个回调,具体定义参看wke.h文件。


void wkePerformCookieCommand(wkeWebView webView, wkeCookieCommand command)

【说明】:通过设置webView内置的curl来操作cookie,这个接口只是调用curl设置命令,并不会去修改js里的内容,#command:是个枚举变量,具体定义参看wke.h文件。

【参数】:command:是个枚举变量,具体定义参看wke.h文件。


void wkeSetCookieEnabled(wkeWebView webView, bool enable)

【说明】:开启或关闭cookie,这个接口只是影响当前渲染的页面,并不会设置curl。所以还是会生成curl的cookie文件。

【参数】:略。。。


BOOL wkeIsCookieEnabled(wkeWebView webView)

【说明】:判断cookie是否开启。

【参数】:略。。。


void wkeSetCookieJarPath(wkeWebView webView, const WCHAR* path)

【说明】:设置cookie的本地文件名,默认是cookie.dat,生成在node.dll的同目录,应广大粉丝的强烈要求,每个webView可以单独设置cookie,互不干扰,新cookie从调用这个接口后开始生效。

【参数】:略。。。


void wkeSetCookieJarFullPath(wkeWebView webView, const WCHAR* path)

【说明】:设置cookie的全路径+文件名,如c:\mb\cookie.dat。

【参数】:略。。。


void wkeClearCookie(wkeWebView webView)

【说明】:清除cookie,由于缓存等因素,直接删cookie.dat可能更有效。另外有的网站可能有服务端缓存,所以会存在清理无效的情况。

【参数】:略。。。


void wkeSetLocalStorageFullPath(wkeWebView webView, const WCHAR* path)

【说明】:设置local storage的全路径。如c:\mb\LocalStorage\,必须且只能是目录,默认是node.dll的同目录,应广大粉丝的强烈要求,每个webView可以单独设置LocalStorage(需要VIP版本才支持),互不干扰,新LocalStorage目录从调用这个接口后开始生效。

【参数】:略。。。


void wkeAddPluginDirectory(wkeWebView webView, const WCHAR* path)

【说明】:添加插件目录。

【参数】:略。。。


float wkeMediaVolume(wkeWebView webView)

【说明】:获取音量,返回一个0到1的音量百分比。

【参数】:略。。。


void wkeSetMediaVolume(wkeWebView webView, float volume)

【说明】:设置音量,暂未实现,稍安勿躁。

【参数】:略。。。


float wkeGetMediaVolume(wkeWebView webView)

【说明】:获取音量,暂未实现,稍安勿躁。

【参数】:略。。。


BOOL wkeFireMouseEvent(wkeWebView webView, unsigned int message, int x, int y, unsigned int flags)

【说明】:触发一个鼠标事件,#message:WM_MOUSELEAVE等Windows标准消息,参考Windows系统API定义,#x和y:相对窗口左上角的像素坐标,#flags:WKE_CONTROL、WKE_SHIFT等标记值,可以“|”操作,具体可参考Windows系统API定义。

【参数】:message:WM_MOUSELEAVE等Windows标准消息,参考Windows系统API定义,
                 x和y:相对窗口左上角的像素坐标,
                 flags:WKE_CONTROL、WKE_SHIFT等标记值,可以“|”操作,具体可参考Windows系统API定义。


BOOL wkeFireContextMenuEvent(wkeWebView webView, int x, int y, unsigned int flags)

【说明】:向webView发送菜单消息,暂未实现,稍安勿躁。

【参数】:略。。。


BOOL wkeFireMouseWheelEvent(wkeWebView webView, int x, int y, int delta, unsigned int flags)

【说明】:向webView发送滚轮消息,参数可参考wkeMouseEvent接口,#delta:这个参数有点麻烦,可参考Windows相关API解释。

【参数】:delta:这个参数有点麻烦,可参考Windows相关API解释。


BOOL wkeFireKeyUpEvent(wkeWebView webView, unsigned int virtualKeyCode, unsigned int flags, bool systemKey)

【说明】:向webView发送WM_KEYUP消息,#virtualKeyCode:可参考Windows相关API定义,#flags:同wkeMouseEvent接口,#systemKey:暂时没用。

【参数】:virtualKeyCode:可参考Windows相关API定义,
                 flags:同wkeMouseEvent接口,
                 systemKey:暂时没用。


BOOL wkeFireKeyDownEvent(wkeWebView webView, unsigned int virtualKeyCode, unsigned int flags, bool systemKey)

【说明】:向webView发送WM_KEYDOWN消息,参数可参考wkeFireKeyUpEvent接口。

【参数】:略。。。


BOOL wkeFireKeyPressEvent(wkeWebView webView, unsigned int charCode, unsigned int flags, bool systemKey)

【说明】:向webView发送WM_KEYPRESS消息,参数可参考wkeFireKeyUpEvent接口。

【参数】:略。。。


BOOL wkeFireWindowsMessage(wkeWebView webView, HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam, LRESULT* result)

【说明】:向webView发送任意Windows消息,主要用来处理光标相关消息,在无窗口模式下,要响应光标事件需要通过本函数手动发送光标消息。

【参数】:略。。。


BOOL wkeMouseEvent(wkeWebView webView, unsigned int message, int x, int y, unsigned int flags)

【说明】:同wkeFireMouseEvent。

【参数】:略。。。


BOOL wkeContextMenuEvent(wkeWebView webView, int x, int y, unsigned int flags)

【说明】:同wkeFireContextMenuEvent。

【参数】:略。。。


BOOL wkeMouseWheel(wkeWebView webView, int x, int y, int delta, unsigned int flags)

【说明】:同wkeFireMouseWheelEvent。

【参数】:略。。。


BOOL wkeKeyUp(wkeWebView webView, unsigned int virtualKeyCode, unsigned int flags, bool systemKey)

【说明】:同wkeFireKeyUpEvent。

【参数】:略。。。


BOOL wkeKeyDown(wkeWebView webView, unsigned int virtualKeyCode, unsigned int flags, bool systemKey)

【说明】:同wkeFireKeyDownEvent。

【参数】:略。。。


BOOL wkeKeyPress(wkeWebView webView, unsigned int virtualKeyCode, unsigned int flags, bool systemKey)

【说明】:同wkeFireKeyPressEvent。

【参数】:略。。。


void wkeSetFocus(wkeWebView webView)

【说明】:设置webview获得焦点。如果webveiw绑定了窗口,窗口也会获得焦点。

【参数】:略。。。


void wkeKillFocus(wkeWebView webView)

【说明】:设置webview失去焦点。

【参数】:略。。。


void wkeFocus(wkeWebView webView)

【说明】:同wkeSetFocus。

【参数】:略。。。


void wkeUnfocus(wkeWebView webView)

【说明】:同wkeKillFocus。

【参数】:略。。。


wkeRect wkeGetCaretRect(wkeWebView webView)

【说明】:获取编辑框中光标的位置。

【参数】:略。。。


wkeRect* wkeGetCaretRect2(wkeWebView webView)

【说明】:同wkeGetCaretRect,不方便处理结构体数据类型的语言可使用本接口。

【参数】:略。。。


wkeRect wkeGetCaret(wkeWebView webView)

【说明】:同wkeGetCaretRect。

【参数】:略。。。


jsValue wkeRunJS(wkeWebView webView, const utf8* script)

【说明】:在一个闭包中运行一段js代码,由于js是弱类型语言,返回值统一用jsValue类型表示(jsValue其实是个封装了v8内部各种类型的类),后面提供了一组用于具体类型转换的接口。

【参数】:略。。。


jsValue wkeRunJSW(wkeWebView webView, const wchar_t* script)

【说明】:宽字符版wkeRunJS,功能完全相同。

【参数】:略。。。


jsExecState wkeGlobalExec(wkeWebView webView)

【说明】:获取页面主frame的jsExecState,jsExecState可以理解为一个句柄,js相关接口会频繁使用该句柄,使用完立刻就失效,再次使用需重新获取。

【参数】:略。。。


jsExecState wkeGetGlobalExecByFrame(wkeWebView webView, wkeWebFrameHandle frameId)

【说明】:获取页面指定frame的jsExecState

【参数】:略。。。


void wkeSleep(wkeWebView webView)

【说明】:使webView进入休眠状态,暂未实现,稍安勿躁。

【参数】:略。。。


void wkeWake(wkeWebView webView)

【说明】:唤醒webView,配合wkeSleep使用。

【参数】:略。。。


void wkeAwaken(wkeWebView webView)

【说明】:同wkeWake。

【参数】:略。。。


BOOL wkeIsAwake(wkeWebView webView)

【说明】:判断webView是否处于休眠状态,暂未实现,稍安勿躁。

【参数】:略。。。


int wkeGetWebviewId(wkeWebView webView)

【说明】:获取webView的id,没啥用。

【参数】:略。。。


BOOL wkeIsWebviewAlive(int id)

【说明】:同wkeIsAwake。

【参数】:略。。。


BOOL wkeIsWebviewValid(wkeWebView webView)

【说明】:判断webView是否是无效状态。

【参数】:略。。。


void wkeSetZoomFactor(wkeWebView webView, float factor)

【说明】:设置页面缩放系数,默认是1。

【参数】:略。。。


float wkeGetZoomFactor(wkeWebView webView)

【说明】:获取页面缩放系数。

【参数】:略。。。


float wkeZoomFactor(wkeWebView webView)

【说明】:同wkeGetZoomFactor。

【参数】:略。。。


void wkeEnableHighDPISupport()

【说明】:开启高分屏支持,本质是通过设置ZOOM并且关闭系统默认缩放来实现的,所以再使用wkeGetZoomFactor会发现值可能不为1。

【参数】:略。。。


void wkeSetEditable(wkeWebView webView, bool editable)

【说明】:设置webView是否可编辑,暂未实现,稍安勿躁。

【参数】:略。。。


wkeWebView wkeGetWebViewForCurrentContext()

【说明】:获取当前线程环境内的webView。

【参数】:略。。。


void wkeSetUserKeyValue(wkeWebView webView, const char* key, void* value)

【说明】:对webView设置一个kv键值对,可以用来存放你喜欢的任何数据。

【参数】:略。。。


void* wkeGetUserKeyValue(wkeWebView webView, const char* key)

【说明】:获取webView指定key对应的value。

【参数】:略。。。


int wkeGetCursorInfoType(wkeWebView webView)

【说明】:获取当前光标类型。

【参数】:略。。。


void wkeSetCursorInfoType(wkeWebView webView, int type)

【说明】:设置当前光标类型,#type:参看Windows系统定义的光标枚举数据类型。

【参数】:type:参看Windows系统定义的光标枚举数据类型。


void wkeSetDragFiles(wkeWebView webView, const POINT* clintPos, const POINT* screenPos, wkeString files[], int filesCount)

【说明】:设置文件拖拽支持。

【参数】:略。。。


void wkeSetDeviceParameter(wkeWebView webView, const char* device, const char* paramStr, int paramInt, float paramFloat)

【说明】:设置webView模拟硬件设备环境,由于现在网页大多通过多种方式判断客户端类型,所以这个接口只能做个调试,实际应用中进行模拟基本没啥用。#device:设备的字符串。可取值如下:navigator.maxTouchPoints时,paramInt需设置,表示touch的点数。navigator.platform时,paramStr需设置,表示js里获取的navigator.platform字符串。navigator.hardwareConcurrency时,paramInt需设置,表示js里获取的navigator.hardwareConcurrency整数值。screen.width时,paramInt需设置,表示js里获取的screen.width整数值。screen.height时,paramInt需设置,表示js里获取的screen.height整数值。screen.availWidth时,paramInt需设置,表示js里获取的screen.availWidth整数值。screen.availHeight时,paramInt需设置,表示js里获取的screen.availHeight整数值。screen.pixelDepth时,paramInt需设置,表示js里获取的screen.pixelDepth整数值。

【参数】:device:设备的字符串。可取值如下:navigator.maxTouchPoints时,paramInt需设置,表示touch的点数。navigator.platform时,paramStr需设置,表示js里获取的navigator.platform字符串。navigator.hardwareConcurrency时,paramInt需设置,表示js里获取的navigator.hardwareConcurrency整数值。screen.width时,paramInt需设置,表示js里获取的screen.width整数值。screen.height时,paramInt需设置,表示js里获取的screen.height整数值。screen.availWidth时,paramInt需设置,表示js里获取的screen.availWidth整数值。screen.availHeight时,paramInt需设置,表示js里获取的screen.availHeight整数值。screen.pixelDepth时,paramInt需设置,表示js里获取的screen.pixelDepth整数值。


wkeTempCallbackInfo* wkeGetTempCallbackInfo(wkeWebView webView)

【说明】:网络访问时供MB内部使用。

【参数】:略。。。


void wkeShowDevtools(wkeWebView webView, const wchar_t* path, wkeOnShowDevtoolsCallback callback, void* param)

【说明】:显示开发者调试工具。

【参数】:略。。。


void wkeOnMouseOverUrlChanged(wkeWebView webView, wkeTitleChangedCallback callback, void* callbackParam)

【说明】:鼠标滑过url时触发此回调。

【参数】:略。。。


void wkeOnTitleChanged(wkeWebView webView, wkeTitleChangedCallback callback, void* callbackParam)

【说明】:标题改变时触发此回调。

【参数】:略。。。


void wkeOnURLChanged(wkeWebView webView, wkeURLChangedCallback callback, void* callbackParam)

【说明】:url改变时触发此回调。

【参数】:略。。。


void wkeOnURLChanged2(wkeWebView webView, wkeURLChangedCallback2 callback, void* callbackParam)

【说明】:url改变时触发此回调。

【参数】:略。。。


void wkeOnPaintUpdated(wkeWebView webView, wkePaintUpdatedCallback callback, void* callbackParam)

【说明】:页面任何区域刷新时触发此回调。

【参数】:略。。。


void wkeOnPaintBitUpdated(wkeWebView webView, wkePaintBitUpdatedCallback callback, void* callbackParam)

【说明】:同wkeOnPaintUpdated,不同的是回调过来的是填充好像素的buffer,而不是DC。方便嵌入到游戏中做离屏渲染。

【参数】:略。。。


void wkeOnAlertBox(wkeWebView webView, wkeAlertBoxCallback callback, void* callbackParam)

【说明】:网页弹出alert时触发此回调。

【参数】:略。。。


void wkeOnConfirmBox(wkeWebView webView, wkeConfirmBoxCallback callback, void* callbackParam)

【说明】:网页弹出Confirm时触发此回调。

【参数】:略。。。


void wkeOnPromptBox(wkeWebView webView, wkePromptBoxCallback callback, void* callbackParam)

【说明】:网页弹出Prompt时触发此回调。

【参数】:略。。。


void wkeOnConsole(wkeWebView webView, wkeConsoleCallback callback, void* param)

【说明】:有Console输出时触发此回调。

【参数】:略。。。


void wkeOnNavigation(wkeWebView webView, wkeNavigationCallback callback, void* param)

【说明】:页面导航时触发此回调。

【参数】:略。。。


void wkeOnCreateView(wkeWebView webView, wkeCreateViewCallback callback, void* param)

【说明】:新建webView时触发此回调,一般配合wkeSetNavigationToNewWindowEnable开关使用,创建多tab浏览窗口。

【参数】:略。。。


void wkeOnDocumentReady(wkeWebView webView, wkeDocumentReadyCallback callback, void* param)

【说明】:网页Document数据结构生成完成时触发此回调,注意由于现在网页多采用异步加载模式,Document数据结构生成完成 ≠ 网页加载完成,每个异步执行的加载动作完成时都可能会触发一次本回调,注意是可能,不是一定,另外页面中如有多个frame,每个frame加载完成时都会触发一次本回调,请具体情况具体分析,推荐通过页面上的某个元素是否存在来判断网页是否加载完成。

【参数】:略。。。


void wkeOnDocumentReady2(wkeWebView webView, wkeDocumentReady2Callback callback, void* param)

【说明】:同wkeOnDocumentReady。

【参数】:略。。。


void wkeOnLoadingFinish(wkeWebView webView, wkeLoadingFinishCallback callback, void* param)

【说明】:页面加载完成时触发此回调,注意事项参看wkeOnDocumentReady。

【参数】:略。。。


void wkeOnDownload(wkeWebView webView, wkeDownloadCallback callback, void* param)

【说明】:有下载文件时触发此回调。

【参数】:略。。。


void wkeOnDownload2(wkeWebView webView, wkeDownload2Callback callback, void* param)

【说明】:同wkeOnDownload。

【参数】:略。。。


void wkeSetUIThreadCallback(wkeWebView webView, wkeCallUiThread callback, void* param)

【说明】:对UI线程有操作时触发此回调,暂未实现,稍安勿躁。

【参数】:略。。。


void wkeOnLoadUrlBegin(wkeWebView webView, wkeLoadUrlBeginCallback callback, void* callbackParam)

【说明】:网页数据已从服务器发送至本地后,但还未开始渲染或应答服务器前触发此回调,广受老铁们爱戴的接口,配合其他网络接口可以进行各种骚操作。

【参数】:略。。。


void wkeOnLoadUrlEnd(wkeWebView webView, wkeLoadUrlEndCallback callback, void* callbackParam)

【说明】:网页加载结束前触发此回调,只有设置了wkeNetSetData和wkeNetHookRequest才会触发该接口。

【参数】:略。。。


void wkeOnLoadUrlFail(wkeWebView webView, wkeLoadUrlFailCallback callback, void* callbackParam)

【说明】:网页加载失败时触发此回调。

【参数】:略。。。


void wkeNetOnResponse(wkeWebView webView, wkeNetResponseCallback callback, void* param)

【说明】:网络请求发送后,收到服务器response时触发此回调。

【参数】:略。。。


void wkeOnDidCreateScriptContext(wkeWebView webView, wkeDidCreateScriptContextCallback callback, void* callbackParam)

【说明】:执行js前触发此回调。

【参数】:略。。。


void wkeOnWillReleaseScriptContext(wkeWebView webView, wkeWillReleaseScriptContextCallback callback, void* callbackParam)

【说明】:执行js完成时触发此回调。

【参数】:略。。。


void wkeOnWindowClosing(wkeWebView webWindow, wkeWindowClosingCallback callback, void* param)

【说明】:wkeWebView如果是正常窗口模式,则在收到WM_CLODE消息时触发此回调接口,可返回false拒绝关闭窗口。

【参数】:略。。。


void wkeOnWindowDestroy(wkeWebView webWindow, wkeWindowDestroyCallback callback, void* param)

【说明】:窗口即将被销毁时触发此回调,这个操作一旦开始则无法取消。

【参数】:略。。。


void wkeOnDraggableRegionsChanged(wkeWebView webView, wkeDraggableRegionsChangedCallback callback, void* param)

【说明】:拖拽区域改变时触发此回调。

【参数】:略。。。


void wkeOnWillMediaLoad(wkeWebView webView, wkeWillMediaLoadCallback callback, void* param)

【说明】:video等多媒体标签创建时触发此回调。

【参数】:略。。。


void wkeOnStartDragging(wkeWebView webView, wkeStartDraggingCallback callback, void* param)

【说明】:开始拖拽操作时触发此回调。

【参数】:略。。。


void wkeOnPrint(wkeWebView webView, wkeOnPrintCallback callback, void* param)

【说明】:打印时触发此回调。

【参数】:略。。。


void wkeScreenshot(wkeWebView webView, const wkeScreenshotSettings* settings, wkeOnScreenshot callback, void* param)

【说明】:截图时触发此回调。

【参数】:略。。。


void wkeOnOtherLoad(wkeWebView webView, wkeOnOtherLoadCallback callback, void* param)

【说明】:加载时触发此回调。

【参数】:略。。。


void wkeOnContextMenuItemClick(wkeWebView webView, wkeOnContextMenuItemClickCallback callback, void* param)

【说明】:菜单点击时触发此回调。

【参数】:略。。。


int wkeNetGetFavicon(wkeWebView webView, wkeOnNetGetFaviconCallback callback, void* param)

【说明】:获取favicon图标,此接口需在wkeOnLoadingFinish回调里调用。

【参数】:略。。。


BOOL wkeIsProcessingUserGesture(wkeWebView webView)

【说明】:用于判断是否收到用户手势操作。

【参数】:略。。。


void wkeSetViewNetInterface(wkeWebView webView, const char* netInterface)

【说明】:设置网络接口,一般用不到。

【参数】:略。。。


void wkeNetSetMIMEType(wkeNetJob jobPtr, const char* type)

【说明】:在wkeOnLoadUrlBegin回调里调用,设置http请求的MIME type。

【参数】:略。。。


const char* wkeNetGetMIMEType(wkeNetJob jobPtr, wkeString mime)

【说明】:获取response的MIME type。

【参数】:略。。。


void wkeNetSetHTTPHeaderField(wkeNetJob jobPtr, const wchar_t* key, const wchar_t* value, bool response)

【说明】:在wkeOnLoadUrlBegin回调里调用,设置http请求(或者file:///协议)的http header field。response一直要被设置成false。

【参数】:略。。。


const char* wkeNetGetHTTPHeaderField(wkeNetJob jobPtr, const char* key)

【说明】:获取HTTP请求头。

【参数】:略。。。


const char* wkeNetGetHTTPHeaderFieldFromResponse(wkeNetJob jobPtr, const char* key)

【说明】:获取HTTP响应头。

【参数】:略。。。


void wkeNetSetData(wkeNetJob jobPtr, void *buf, int len)

【说明】:这是MB最受欢迎的接口之一。调用此接口后,会在网络层收到数据后将数据缓存到内存中并在接收数据完成后将响应OnLoadUrlEnd事件,此接口打断了网络响应流程,严重影响性能。它和wkeNetHookRequest的区别是,wkeNetHookRequest会在接受到真正网络数据后再调用回调,并允许回调修改网络数据。而wkeNetSetData是在网络数据还没发送的时候修改,一般用于塞一段自定义的数据到数据流中。

【参数】:略。。。


void wkeNetHookRequest(wkeNetJob jobPtr)

【说明】:参看wkeNetSetData接口,如果设置了此接口,则在本次网络请求结束后会触发wkeOnLoadUrlEnd回调,同时传递缓存的数据,此时,可以修改这些数据。

【参数】:略。。。


wkeRequestType wkeNetGetRequestMethod(wkeNetJob jobPtr)

【说明】:获取此请求的method类型,wkeRequestType枚举定义参看wke.h文件。

【参数】:略。。。


void wkeNetContinueJob(wkeNetJob jobPtr)

【说明】:参看wkeNetHoldJobToAsynCommit接口。

【参数】:略。。。


const char* wkeNetGetUrlByJob(wkeNetJob jobPtr)

【说明】:通过jobPtr获取当前请求的url。

【参数】:略。。。


const wkeSlist* wkeNetGetRawHttpHead(wkeNetJob jobPtr)

【说明】:获取Raw格式的HTTP请求数据,wkeSlist是个保存了网络数据的链表结构,请参看wke.h文件。

【参数】:略。。。


const wkeSlist* wkeNetGetRawResponseHead(wkeNetJob jobPtr)

【说明】:获取Raw格式的HTTP响应数据,wkeSlist是个保存了网络数据的链表结构,请参看wke.h文件。

【参数】:略。。。


void wkeNetCancelRequest(wkeNetJob jobPtr)

【说明】:取消本次网络请求,需要在wkeOnLoadUrlBegin里调用。

【参数】:略。。。


BOOL wkeNetHoldJobToAsynCommit(wkeNetJob jobPtr)

【说明】:网络访问经常存在异步操作,当wkeOnLoadUrlBegin里拦截到一个请求后如不能马上判断出结果,此时可以调用本接口,处理完成后需调用wkeNetContinueJob来让此请求继续。注意:返回true代表成功,false代表调用失败,如失败则不能再调用wkeNetContinueJob。

【参数】:略。。。


void wkeNetChangeRequestUrl(wkeNetJob jobPtr, const char* url)

【说明】:修改当前请求的url。

【参数】:略。。。


wkeWebUrlRequestPtr wkeNetCreateWebUrlRequest(const utf8* url, const utf8* method, const utf8* mime)

【说明】:创建一个网络请求,wkeWebUrlRequestPtr定义请参看wke.h文件。

【参数】:略。。。


wkeWebUrlRequestPtr wkeNetCreateWebUrlRequest2(const blinkWebURLRequestPtr request)

【说明】:创建一个网络请求,wkeWebUrlRequestPtr和blinkWebURLRequestPtr定义请参看wke.h文件。

【参数】:略。。。


blinkWebURLRequestPtr wkeNetCopyWebUrlRequest(wkeNetJob jobPtr, bool needExtraData)

【说明】:复制一个网络请求,blinkWebURLRequestPtr定义请参看wke.h文件。

【参数】:略。。。


void wkeNetDeleteBlinkWebURLRequestPtr(blinkWebURLRequestPtr request)

【说明】:取消网络请求。

【参数】:略。。。


void wkeNetAddHTTPHeaderFieldToUrlRequest(wkeWebUrlRequestPtr request, const utf8* name, const utf8* value)

【说明】:在指定网络请求中插入一个请求头。

【参数】:略。。。


int wkeNetStartUrlRequest(wkeWebView webView, wkeWebUrlRequestPtr request, void* param, const wkeUrlRequestCallbacks* callbacks)

【说明】:开始网络请求。

【参数】:略。。。


int wkeNetGetHttpStatusCode(wkeWebUrlResponsePtr response)

【说明】:获取HTTP响应状态码。

【参数】:略。。。


__int64 wkeNetGetExpectedContentLength(wkeWebUrlResponsePtr response)

【说明】:获取响应数据大小。

【参数】:略。。。


const utf8* wkeNetGetResponseUrl(wkeWebUrlResponsePtr response)

【说明】:获取响应url。

【参数】:略。。。


void wkeNetCancelWebUrlRequest(int requestId)

【说明】:取消网络请求。

【参数】:略。。。


wkePostBodyElements* wkeNetGetPostBody(wkeNetJob jobPtr)

【说明】:获取此请求中的post数据,注意:只有当请求是post时才可获取到,get请求直接从url上取就好了。

【参数】:略。。。


wkePostBodyElements* wkeNetCreatePostBodyElements(wkeWebView webView, size_t length)

【说明】:创建一组post数据内容,wkePostBodyElements数据结构参看wke.h文件。

【参数】:略。。。


void wkeNetFreePostBodyElements(wkePostBodyElements* elements)

【说明】:干掉指定的post数据内容组,释放内存。

【参数】:略。。。


wkePostBodyElement* wkeNetCreatePostBodyElement(wkeWebView webView)

【说明】:创建一个post数据内容,wkePostBodyElement数据结构参看wke.h文件。

【参数】:略。。。


void wkeNetFreePostBodyElement(wkePostBodyElement* element)

【说明】:干掉指定的post数据内容,释放内存。

【参数】:略。。。


BOOL wkeIsMainFrame(wkeWebView webView, wkeWebFrameHandle frameId)

【说明】:判断是否是主frame。

【参数】:略。。。


BOOL wkeIsWebRemoteFrame(wkeWebView webView, wkeWebFrameHandle frameId)

【说明】:判断是否是远程frame。

【参数】:略。。。


wkeWebFrameHandle wkeWebFrameGetMainFrame(wkeWebView webView)

【说明】:获取主frame,wkeWebFrameHandle定义参看wke.h文件。

【参数】:略。。。


jsValue wkeRunJsByFrame(wkeWebView webView, wkeWebFrameHandle frameId, const utf8* script, bool isInClosure)

【说明】:在指定frame中执行一段js代码。

【参数】:略。。。


void wkeInsertCSSByFrame(wkeWebView webView, wkeWebFrameHandle frameId, const utf8* cssText)

【说明】:在指定frame中插入一段css。

【参数】:略。。。


void wkeWebFrameGetMainWorldScriptContext(wkeWebView webView, wkeWebFrameHandle webFrameId, v8ContextPtr contextOut)

【说明】:获取全局脚本上下文。

【参数】:略。。。


v8Isolate wkeGetBlinkMainThreadIsolate()

【说明】:获取渲染主线程的隔离环境。

【参数】:略。。。


wkeWebView wkeCreateWebWindow(wkeWindowType type, HWND parent, int x, int y, int width, int height)

【说明】:创建一个带真实窗口的wkeWebView,#type:枚举类型变量,WKE_WINDOW_TYPE_POPUP为普通窗口。WKE_WINDOW_TYPE_TRANSPARENT为透明窗口,通过layer window实现。WKE_WINDOW_TYPE_CONTROL为嵌入在父窗口里的子窗口,需设置parent句柄。

【参数】:type:枚举类型变量,WKE_WINDOW_TYPE_POPUP为普通窗口。WKE_WINDOW_TYPE_TRANSPARENT为透明窗口,通过layer window实现。WKE_WINDOW_TYPE_CONTROL为嵌入在父窗口里的子窗口,需设置parent句柄。


wkeWebView wkeCreateWebCustomWindow(const wkeWindowCreateInfo* info)

【说明】:创建一个带真实窗口的wkeWebView,#info:被定义为一个结构体,具体定义参看wke.h头文件。

【参数】:info:被定义为一个结构体,具体定义参看wke.h头文件。


void wkeDestroyWebWindow(wkeWebView webWindow)

【说明】:干掉wkeWebView对应的所有资源,包括真实窗口等。

【参数】:略。。。


void wkeShowWindow(wkeWebView webWindow, bool show)

【说明】:设置是否显示窗口。

【参数】:略。。。


void wkeEnableWindow(wkeWebView webWindow, bool enable)

【说明】:设置是否激活窗口。

【参数】:略。。。


void wkeMoveWindow(wkeWebView webWindow, int x, int y, int width, int height)

【说明】:移动窗口。参数为从指定坐标移动指定的距离。

【参数】:略。。。


void wkeMoveToCenter(wkeWebView webWindow)

【说明】:设置webView窗口在其父窗口或屏幕居中。

【参数】:略。。。


void wkeResizeWindow(wkeWebView webWindow, int width, int height)

【说明】:同wkeResize。

【参数】:略。。。


wkeWebDragOperation wkeDragTargetDragEnter(wkeWebView webView, const wkeWebDragData* webDragData, const POINT* clientPoint, const POINT* screenPoint, wkeWebDragOperationsMask operationsAllowed, int modifiers)

【说明】:进入拖拽目标区域。

【参数】:略。。。


wkeWebDragOperation wkeDragTargetDragOver(wkeWebView webView, const POINT* clientPoint, const POINT* screenPoint, wkeWebDragOperationsMask operationsAllowed, int modifiers)

【说明】:越过拖拽目标区域。

【参数】:略。。。


void wkeDragTargetDragLeave(wkeWebView webView)

【说明】:离开拖拽目标区域。

【参数】:略。。。


void wkeDragTargetDrop(wkeWebView webView, const POINT* clientPoint, const POINT* screenPoint, int modifiers)

【说明】:拖拽至目标区域后释放被拖拽对象。

【参数】:略。。。


void wkeDragTargetEnd(wkeWebView webView, const POINT* clientPoint, const POINT* screenPoint, wkeWebDragOperation operation)

【说明】:拖拽结束。

【参数】:略。。。


void wkeUtilSetUiCallback(wkeUiThreadPostTaskCallback callback)

【说明】:设置UI线程回调。

【参数】:略。。。


const utf8* wkeUtilSerializeToMHTML(wkeWebView webView)

【说明】:转成MHTML代码。

【参数】:略。。。


const wkePdfDatas* wkeUtilPrintToPdf(wkeWebView webView, wkeWebFrameHandle frameId, const wkePrintSettings* settings)

【说明】:打印PDF,wkePrintSettings结构参看wke.h文件。

【参数】:略。。。


const wkeMemBuf* wkePrintToBitmap(wkeWebView webView, wkeWebFrameHandle frameId, const wkeScreenshotSettings* settings)

【说明】:打印位图,wkeScreenshotSettings结构参看wke.h文件。

【参数】:略。。。


void wkeUtilRelasePrintPdfDatas(const wkePdfDatas* datas)

【说明】:释放打印PDF数据。

【参数】:略。。。


void wkeSetWindowTitle(wkeWebView webWindow, const utf8* title)

【说明】:设置窗口标题。

【参数】:略。。。


void wkeSetWindowTitleW(wkeWebView webWindow, const wchar_t* title)

【说明】:宽字符版wkeSetWindowTitle。

【参数】:略。。。


void wkeNodeOnCreateProcess(wkeWebView webView, wkeNodeOnCreateProcessCallback callback, void* param)

【说明】:创建node时触发此回调。

【参数】:略。。。


void wkeOnPluginFind(wkeWebView webView, const char* mime, wkeOnPluginFindCallback callback, void* param)

【说明】:查找插件时触发此回调。

【参数】:略。。。


void wkeAddNpapiPlugin(wkeWebView webView, void* initializeFunc, void* getEntryPointsFunc, void* shutdownFunc)

【说明】:给webView添加Npapi插件。

【参数】:略。。。


void wkePluginListBuilderAddPlugin(void* builder, const utf8* name, const utf8* description, const utf8* fileName)

【说明】:往插件列表中添加插件。

【参数】:略。。。


void wkePluginListBuilderAddMediaTypeToLastPlugin(void* builder, const utf8* name, const utf8* description)

【说明】:往插件列表中添加多媒体插件。

【参数】:略。。。


void wkePluginListBuilderAddFileExtensionToLastMediaType(void* builder, const utf8* fileExtension)

【说明】:往插件列表中添加文件扩展插件。

【参数】:略。。。


wkeWebView wkeGetWebViewByNData(void* ndata)

【说明】:从ndata中获取webView。

【参数】:略。。。


BOOL wkeRegisterEmbedderCustomElement(wkeWebView webView, wkeWebFrameHandle frameId, const char* name, void* options, void* outResult)

【说明】:注册自定义元素。

【参数】:略。。。


void wkeSetMediaPlayerFactory(wkeWebView webView, wkeMediaPlayerFactory factory, wkeOnIsMediaPlayerSupportsMIMEType callback)

【说明】:设置多媒体图标。

【参数】:略。。。


const utf8* wkeGetContentAsMarkup(wkeWebView webView, wkeWebFrameHandle frame, size_t* size)

【说明】:获取标记内容。

【参数】:略。。。


const utf8* wkeUtilDecodeURLEscape(const utf8* url)

【说明】:URLEscape解码。

【参数】:略。。。


const utf8* wkeUtilEncodeURLEscape(const utf8* url)

【说明】:URLEscape编码。

【参数】:略。。。


const utf8* wkeUtilBase64Encode(const utf8* str)

【说明】:base64编码。

【参数】:略。。。


const utf8* wkeUtilBase64Decode(const utf8* str)

【说明】:base64解码。

【参数】:略。。。


const wkeMemBuf* wkeUtilCreateV8Snapshot(const utf8* str)

【说明】:创建V8内存快照。

【参数】:略。。。


void wkeRunMessageLoop()

【说明】:执行消息循环。

【参数】:略。。。


void wkeSaveMemoryCache(wkeWebView webView)

【说明】:保存webView内存缓存。

【参数】:略。。。


void jsBindFunction(const char* name, jsNativeFunction fn, unsigned int argCount)

【说明】:绑定一个全局函数到主frame上,用于在js代码中调用c++函数。此接口只能绑定主frame,注意:此接口是fastcall调用约定,但wkeJsBindFunction不是,另外此接口和wkeJsBindFunction必须在webview创建前调用。#name:绑定的函数名,在js代码中执行同名函数,会触发c++中的fn函数,从而达到在js中调用c++的效果。

【参数】:name:绑定的函数名,在js代码中执行同名函数,会触发c++中的fn函数,从而达到在js中调用c++的效果。


void jsBindGetter(const char* name, jsNativeFunction fn)

【说明】:对js winows绑定一个属性访问器,在js里windows.XXX这种形式调用时,会触发c++中的fn函数。

【参数】:略。。。


void jsBindSetter(const char* name, jsNativeFunction fn)

【说明】:对js winows绑定一个属性设置器。

【参数】:略。。。


void wkeJsBindFunction(const char* name, wkeJsNativeFunction fn, void* param, unsigned int argCount)

【说明】:参看jsBindFunction。

【参数】:略。。。


void wkeJsBindGetter(const char* name, wkeJsNativeFunction fn, void* param)

【说明】:参看jsBindGetter。

【参数】:略。。。


void wkeJsBindSetter(const char* name, wkeJsNativeFunction fn, void* param)

【说明】:参看jsBindSetter。

【参数】:略。。。


int jsArgCount(jsExecState es)

【说明】:获取es里存的参数个数,一般是在绑定的js调用c++回调里使用,判断js传递了多少个参数给c++。

【参数】:略。。。


jsType jsArgType(jsExecState es, int argIdx)

【说明】:判断第argIdx个参数的参数类型,从0开始计数,jsType定义参看wke.h文件。

【参数】:略。。。


jsValue jsArg(jsExecState es, int argIdx)

【说明】:获取第argIdx个参数的jsValue值,从0开始计数,jsValue定义参看wke.h文件。

【参数】:略。。。


jsType jsTypeOf(jsValue v)

【说明】:获取v的数据类型,jsType定义参看wke.h文件。

【参数】:略。。。


BOOL jsIsNumber(jsValue v)

【说明】:判断v是否为数字。

【参数】:略。。。


BOOL jsIsString(jsValue v)

【说明】:判断v是否为字符串。

【参数】:略。。。


BOOL jsIsBoolean(jsValue v)

【说明】:判断v是否为bool值。

【参数】:略。。。


BOOL jsIsObject(jsValue v)

【说明】:判断v是否为Object对象。

【参数】:略。。。


BOOL jsIsFunction(jsValue v)

【说明】:判断v是否为函数。

【参数】:略。。。


BOOL jsIsUndefined(jsValue v)

【说明】:判断v是否为未定义。

【参数】:略。。。


BOOL jsIsNull(jsValue v)

【说明】:判断v是否为null。

【参数】:略。。。


BOOL jsIsArray(jsValue v)

【说明】:判断v是否为数组型。

【参数】:略。。。


BOOL jsIsTrue(jsValue v)

【说明】:如果v本身是个布尔值,返回对应的true或者false,如果是个对象(JSTYPE_OBJECT),返回false。

【参数】:略。。。


BOOL jsIsFalse(jsValue v)

【说明】:等价于!jsIsTrue(v)。

【参数】:略。。。


int jsToInt(jsExecState es, jsValue v)

【说明】:如果v是个整形则返回相应值,如果是浮点型则返回取整后的值,如果是其他类型则返回0。

【参数】:略。。。


float jsToFloat(jsExecState es, jsValue v)

【说明】:如果v是个浮点型则返回相应值,如果是其他类型则返回0.0。

【参数】:略。。。


double jsToDouble(jsExecState es, jsValue v)

【说明】:如果v是个浮点型则返回相应值,如果是其他类型则返回0.0。

【参数】:略。。。


const char* jsToDoubleString(jsExecState es, jsValue v)

【说明】:如果v是个DoubleString型则返回相应值,如果是其他类型则返回空字符串

【参数】:略。。。


BOOL jsToBoolean(jsExecState es, jsValue v)

【说明】:如果v是个bool型则返回相应值,如果是其他类型则返回FALSE。

【参数】:略。。。


const utf8* jsToTempString(jsExecState es, jsValue v)

【说明】:如果v是个字符串则返回相应值,如果是其他类型则返回空字符串,注意:返回的字符串不需要外部释放,MB会在下一帧自动释放。

【参数】:略。。。


const wchar_t* jsToTempStringW(jsExecState es, jsValue v)

【说明】:宽字符版jsToTempString。

【参数】:略。。。


void* jsToV8Value(jsExecState es, jsValue v)

【说明】:将v转成v8引擎中定义的数据类型,具体定义可参见v8::Persistent*

【参数】:略。。。


const utf8* jsToString(jsExecState es, jsValue v)

【说明】:如果v是个字符串则返回相应值,如果是其他类型则返回空字符串。

【参数】:略。。。


const wchar_t* jsToStringW(jsExecState es, jsValue v)

【说明】:宽字符版jsToString。

【参数】:略。。。


jsValue jsInt(int n)

【说明】:将n转成int型的jsValue。

【参数】:略。。。


jsValue jsFloat(float f)

【说明】:将f转成float型的jsValue。

【参数】:略。。。


jsValue jsDouble(double d)

【说明】:将d转成double型的jsValue。

【参数】:略。。。


jsValue jsDoubleString(const char* str)

【说明】:将str转成doublestring型的jsValue。

【参数】:略。。。


jsValue jsBoolean(bool b)

【说明】:将b转成bool型的jsValue。

【参数】:略。。。


jsValue jsString(jsExecState es, const utf8* str)

【说明】:将str转成string型的jsValue。

【参数】:略。。。


jsValue jsStringW(jsExecState es, const wchar_t* str)

【说明】:宽字符版jsString。

【参数】:略。。。


jsValue jsUndefined()

【说明】:创建一个表示js undefined的jsValue。

【参数】:略。。。


jsValue jsNull()

【说明】:创建一个表示js null的jsValue。

【参数】:略。。。


jsValue jsTrue()

【说明】:创建一个表示js true的jsValue。

【参数】:略。。。


jsValue jsFalse()

【说明】:创建一个表示js false的jsValue。

【参数】:略。。。


jsValue jsEmptyObject(jsExecState es)

【说明】:创建一个表示js object的jsValue。

【参数】:略。。。


jsValue jsEmptyArray(jsExecState es)

【说明】:创建一个表示js array的jsValue。

【参数】:略。。。


jsValue jsArrayBuffer(jsExecState es, const char* buffer, size_t size)

【说明】:将buffer中的数据转成jsValue型,主要用来处理一些二进制数据。

【参数】:略。。。


wkeMemBuf* jsGetArrayBuffer(jsExecState es, jsValue value)

【说明】:将value中的数据转成wkeMemBuf结构,wkeMemBuf结构的定义参看wke.h文件。

【参数】:略。。。


jsValue jsObject(jsExecState es, jsData* obj)

【说明】:将obj转成一个表示js object的jsValue。

【参数】:略。。。


jsValue jsFunction(jsExecState es, jsData* obj)

【说明】:将obj转成一个表示js function的jsValue。

【参数】:略。。。


jsValue jsThrowException(jsExecState es, const utf8* exception)

【说明】:将exception转成一个表示js exception的jsValue。

【参数】:略。。。


jsData* jsGetData(jsExecState es, jsValue object)

【说明】:获取jsObject或jsFunction创建的jsValue对应的jsData指针。jsData数据结构定义参看wke.h文件。

【参数】:略。。。


jsValue jsGet(jsExecState es, jsValue object, const char* prop)

【说明】:如果object是个js的object,则获取prop指定的属性。如果object不是js object类型,则返回jsUndefined。

【参数】:略。。。


void jsSet(jsExecState es, jsValue object, const char* prop, jsValue v)

【说明】:设置object的属性。

【参数】:略。。。


jsValue jsGetAt(jsExecState es, jsValue object, int index)

【说明】:获取js arrary的第index个成员的值,object必须是js array才有用,否则会返回jsUndefined。

【参数】:略。。。


void jsSetAt(jsExecState es, jsValue object, int index, jsValue v)

【说明】:设置js arrary的第index个成员的值,object必须是js array才有用。

【参数】:略。。。


jsKeys* jsGetKeys(jsExecState es, jsValue object)

【说明】:获取object有哪些key,jsKeys定义参看wke.h文件。

【参数】:略。。。


BOOL jsIsJsValueValid(jsExecState es, jsValue object)

【说明】:判断object是否是无效值。

【参数】:略。。。


BOOL jsIsValidExecState(jsExecState es)

【说明】:判断es是否是无效状态。

【参数】:略。。。


void jsDeleteObjectProp(jsExecState es, jsValue object, const char* prop)

【说明】:删除object中的指定prop属性。

【参数】:略。。。


int jsGetLength(jsExecState es, jsValue object)

【说明】:获取object长度。

【参数】:略。。。


void jsSetLength(jsExecState es, jsValue object, int length)

【说明】:设置object长度。

【参数】:略。。。


jsValue jsGlobalObject(jsExecState es)

【说明】:获取全局Object值。

【参数】:略。。。


wkeWebView jsGetWebView(jsExecState es)

【说明】:获取es对应的webview。

【参数】:略。。。


jsValue jsEval(jsExecState es, const utf8* str)

【说明】:执行一段js代码,代码会在MB内部自动被包裹在一个function(){}中,所以使用的变量会作为局部变量,要获取返回值,请加return。

【参数】:略。。。


jsValue jsEvalW(jsExecState es, const wchar_t* str)

【说明】:宽字符版jsEval。

【参数】:略。。。


jsValue jsEvalExW(jsExecState es, const wchar_t* str, bool isInClosure)

【说明】:参看jsEvalW,#isInClosure:设定是否闭包运行js,为true时,获取返回值需要写return,为false则不用。

【参数】:isInClosure:设定是否闭包运行js,为true时,获取返回值需要写return,为false则不用。


jsValue jsCall(jsExecState es, jsValue func, jsValue thisObject, jsValue* args, int argCount)

【说明】:调用页面中的js函数,可以是从js里取的,也可以是自行构造的。#func:要执行的函数。#thisObject:如果此js函数是成员函数,则需要填thisValue,否则可以传jsUndefined。#args:func的参数数组。#argCount:参数个数。

【参数】:func:要执行的函数。
                 thisObject:如果此js函数是成员函数,则需要填thisValue,否则可以传jsUndefined。
                 args:func的参数数组。
                 argCount:参数个数。


jsValue jsCallGlobal(jsExecState es, jsValue func, jsValue* args, int argCount)

【说明】:调用window上的全局函数,参看jsCall。

【参数】:略。。。


jsValue jsGetGlobal(jsExecState es, const char* prop)

【说明】:获取window上的属性

【参数】:略。。。


void jsSetGlobal(jsExecState es, const char* prop, jsValue v)

【说明】:设置window上的属性

【参数】:略。。。


void jsGC()

【说明】:强制js执行垃圾回收。

【参数】:略。。。


BOOL jsAddRef(jsExecState es, jsValue val)

【说明】:将val添加为js引用。

【参数】:略。。。


BOOL jsReleaseRef(jsExecState es, jsValue val)

【说明】:释放val引用。

【参数】:略。。。


jsExceptionInfo* jsGetLastErrorIfException(jsExecState es)

【说明】:返回js执行时产生的异常,jsExceptionInfo数据结构参看wke.h文件,如执行正确返回nullptr。

【参数】:略。。。


const utf8* jsGetCallstack(jsExecState es)

【说明】:返回js执行时的堆栈信息。

【参数】:略。。。


void wkeSetFileSystem(WKE_FILE_OPEN pfnOpen, WKE_FILE_CLOSE pfnClose, WKE_FILE_SIZE pfnSize, WKE_FILE_READ pfnRead, WKE_FILE_SEEK pfnSeek)

【说明】:wke遗留的接口,设置文件相关的hook函数,可用于拦截对文件的操作。

【参数】:略。。。


void wkeShutdown()

【说明】:【已废弃】 关闭整个webView。调用后,所有API将不能再被调用,否则崩给你看。

【参数】:略。。。


void wkeFinalize()

【说明】:【已废弃】 同wkeShutdown。

【参数】:略。。。


BOOL wkeIsLoaded(wkeWebView webView)

【说明】:【已废弃】判断webView是否已被加载。

【参数】:略。。。


BOOL wkeIsLoadFailed(wkeWebView webView)

【说明】:【已废弃】判断webView是否加载失败。

【参数】:略。。。


BOOL wkeIsLoadComplete(wkeWebView webView)

【说明】:【已废弃】判断webView是否加载完成。

【参数】:略。。。


BOOL wkeIsLoadingSucceeded(wkeWebView webView)

【说明】:【已废弃】判断webView是否加载成功。

【参数】:略。。。


void wkeSetDirty(wkeWebView webView, bool dirty)

【说明】:【已废弃】 设置页面为脏状态,在下一帧将强制重绘页面。

【参数】:略。。。


BOOL wkeIsDirty(wkeWebView webView)

【说明】:【已废弃】 获取页面脏状态。

【参数】:略。。。


void wkeAddDirtyArea(wkeWebView webView, int x, int y, int w, int h)

【说明】:【已废弃】 添加页面脏矩形。

【参数】:略。。。


void wkeLayoutIfNeeded(wkeWebView webView)

【说明】:【已废弃】 强制让页面重新排版。

【参数】:略。。。


void wkeRepaintIfNeeded(wkeWebView webView)

【说明】:【已废弃】 强制重绘页面。

【参数】:略。。。




文档结束