FireBreath -- Summary--方法 属性 Attributes 事件和js的交互等

2024-05-12 19:58

本文主要是介绍FireBreath -- Summary--方法 属性 Attributes 事件和js的交互等,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

【方法】

JSAPI 对javascript暴露了四种基本类型的接口(Methods, Properties, Attributes, and Events),每一种接口都必须在JSAPI对象的构造函数中注册(Attributes和Events除外)。

Attributes可以在任何一个除了析构函数的函数中注册(registerAttribute(const std::string& str, const FB:variant& value, bool readOnly = false));


Events在1.5.0之后的版本中注册是在类声明中FB_JSAPI_EVENT(不带on的函数名全小写, 参数个数,  (参数类型列表)); 在cpp文件里的函数中fire_funcName(参数s)即可。


Methods:方法如果没有明确返回一个值则返回undefined,就像js函数。



如果想从js传一个【字典】类型的参数,那么形参可以用std::map(或者任何其他的STL字典类型,比如hash_map, multimap等),但键应该是std::string类型,值可以是任何JSAPIAuto支持的类型。

这是唯一值传递的情况,如果你需要用引用传递一个对象,那么形参应该接受为一个FB::JSObjectPtr类型,并且使用Invoke, GetProperty, SetProperty来操作它。




如果想从js传一个【数组】类型的参数,那么形参可以用std::vector(或者任何其他STL列表类型,比如list, set等),容器中的元素类型可以是任何JSAPI支持的类型。



JSAPIAuto类型支持 继承自FB::variant所支持的类型。 当JSAPIAuto把一个参数转换成你的JSAPI方法或属性期望的类型时,它是通过使用FB::variant::convert_cast<type>来完成的。



FireBreath支持的类型:

数学类型:signed/unsigned int/long/short/char, float, double, size_t

布尔类型:true false

string: FireBreath支持std::string和std::wstring,并且会自动的在两者之间进行转换,需要注意的是:std::string表达式一直都是UTF-8编码



char* 和 wchar_t*:只有作为返回类型(或者assign to a FB::variant)你能使用char* wchar_t*,但是这些会在内部被转换为std::string和std::wstring。


二进制数据:如果你需要传递二进制数据给页面,我们建议你要么转换成一个string(hex, base64等),要么包装成javascipt Array(比如std::vector<unsigned char>)。 传递行业内的数据作为js数组不会特别有效率,但是插件接口不允许二进制数据。 所有的strings都假设浏览器为UTF-8编码,所以简单的返回一个char*可能会产生不可预期的结果。

 


容器类型:FB支持所有的STL容器,并且是100%的兼容。 联合类型可以作为参数传递给JSAPI函数并且js对象会自动的转换,反之,非联合类型可以从js对象中保持数据。

 


方法的注册:        registerMethod("mytestEvent", make_method(this, &cuihaoidentiferAPI::testEvent)); 


注意:需要在js中访问的方法才需要注册,否则可以不用注册。 上例中mytestEvent为暴露给js的函数名,make_method后为真正的函数名。



【属性】


属性分为只读属性和读写属性,属性也是靠函数实现的,即set和get,如下

registerProperty("mystr", make_property(this, &cuihaoidentiferAPI::get_myString, &cuihaoidentiferAPI::set_myString));

上例中是一个读写属性,因为有get和set,如果是只读属性则只写get即可,方法如下:

    std::string get_myString();

    void set_myString(const std::string& str);

这样的方法不需要注册,因为不需要被js访问。




【Attribute】

这个东西应该翻译成什么呢? Attribute和【属性累死】,也分为只读和读写,但是区别是Attribute没有复杂的代码逻辑,只需要注册一下即可,

void FB::JSAPIAuto::registerAttribute( const std::string &name, const FB::variant& value, bool readonly /*= false*/ ),

而这个注册不需要在构造函数里,在任何函数中注册都可以,默认为读写属性,第三个参数为true时即为只读,虽然叫做只读的,但是仅仅是不可以在javascript中改变其值,在C++中还是可以改变其值的。

void cuihaoidentiferAPI::regAttriWR()             //对js提供的注册Attribute的函数

{

    registerAttribute("first", 100); 

}


void cuihaoidentiferAPI::regAttriROnly()         //对js提供的注册Attribute的函数

{

    registerAttribute("second", "cuihao", true);

}


可是,但是,可但是,请注意根据我自己的实验发现:

1、当没有调用注册Attribute的函数registerAttribute时,得到的属性值为undefined(符合预期);

2、当在js中用代码在没有调用registerAttribute的情况下给Attribute赋值时却可以赋值成功,并且就算是只读的也可以赋值成功,

这一点不太明白。

 



【Event】事件

由于浏览器的差异,强烈建议命名事件时遵循如下原则:

1、所有字母小写

2、事件名字必须以"on"开头


例如:

onload  onstart ondead  onsomethingelse ....


FB 1.5.0中的新特性

事件必须总是使用相同的参数个数和参数类型被触发,最后我们在你的JSAPI类上增加了创建方法的宏,这样就能在js中触发事件。这是由你的JSAPI类中的FB_JSAPI_EVENT宏来完成的。 写在class声明中!

语法个数如下:

FB_JSAPI_EVENT({事件名(不带on)}, {参数个数}, {参数类型列表})


eg.

/

class ClassName

{

public:

FB_JSAPI_EVENT(load, 0, ())  //名字为load,参数个数为0,没有参数类型

FB_JSAPI_EVENT(update, 1, (int)) // 名字为update, 一个参数, 类型为int

FB_JSAPI_EVENT(rename, 2, (const std::string& old, const std::string& new))  //名字为rename,参数为2个,    ///                                           //类型为const std::string

}

///


触发事件:

void ClassName::fireAllEvents()

{

fire_load();

fire_update(10);

fire("old name", "new name"); 


}

///


注意:永远不要在析构函数中触发事件(fire event),这样会导致未定义的行为,也许会使得页面重新加载的时候插件崩溃!



在js中使用events:为了在js中处理你的插件中的事件,你需要在插件对象中listen for it。

在所有的IE版本尤其是IE9中, 必须使用attachEvent函数来添加事件,尽管addEventListener在IE9中也是可用的,但是IE从来不会把事件句柄传递给插件,所以如果你不使用attachEvent这样可能会导致失败!

注意:调用attchEvent函数添加事件的时候必须加上“on”!  另外有用户反映在IE中的embed标签中使用插件可能会导致事件不能正常工作,所以请你在OBJECT标签中使用。 


function onPluginLoad()        //对应load事件,无参数

{

   alert("I am  loadding!");

}


function onPluginUpdate(num)   //对应update事件,参数为一个int类型

{

alert("number is " + num);

}


function onPluginRename(old, new)

{

alert(old + "  " + new);

}



function testEvent()

{

var plugin = document.getElementById("pluginID");

plugin.attachEvent("on" + "load", onPluginLoad);

plugin.attachEvent("on" + "update", );

plugin.attachEvent("on" + "rename", onPluginRename);

}


///


在其他浏览器中使用(except IE):使用addEventListener函数来添加事件,而用这个函数添加事件则不需要在事件名前手动加"on",会自动添加"on"。


function onPluginLoad()

{

alert("I ma loadding!");

}


function onPluginUpdate(num)

{

alert("number is " + num);

}


function testEvent()

{

var plugin = document.getElementById("pluginID");

plugin.addEventListener("load", onPluginLoad, false);      //addEventListener有三个参数

plugin.addEventListener("update", onPluginUpdate, false);  //addEventListener有三个参数

}



///自适应不同浏览器///

function testEvent()

{

var plugin = document.getElementById("pluginID");

if(plugin.attachEvent)                             //IE, 或者是判断浏览器内核

{

plugin.attachEvent("on" + "load", onPluginLoad);

}

else

{

plugin.addEventListener("load", onPluginLoad, false);

}

}


注意:FB不支持"useCapture"参数,即addEventListener的第三个参数,忽略,写false为保持语法正确,true也可。


卸载事件:IE;detachEvent(),  非IE:removeEventListener()。


/



在FB 1.5.0 之前的版本中:

注册事件(在构造函数中):

class ClassName

{

public:

registerEvent("onload");

registerEvent("onupdate");

}

///...................


触发事件:

void ClassName::FireEvents()

{

//this->FireEvent("event name", params);  //event name包括"on", 

//params是一个FB::VariantList(std::vector<FB::variant>)。

this->FireEvent("onload", FB::variant_list_of());

this->FireEvent("onupdate", FB::variant_list_of(10));

}





//

再谈实参 形参

js传一个数组参数给插件的方法:在插件的方法中可以使用FB:VariantList做形参或者是任何一个适应实参的STL容器类型。

eg.

plugin.func(new Array(1, "2", 3.0));


//FB::VariantList做形参

bool func(FB::VariantList& array);


//STL做形参

bool func(std::vector<std::string>& array);



如果实参是一个js对象,那么形参可以是一个FB::JSObjectPtr& obj类型。

如果实参是一个js函数,js函数同样也是对象,也可以使用FB::JSObjectPtr& func类型。



如果实参是一组可变参数,那么形参可以使用FB::CatchAll& args,比如:

//js

plugin.add('my stuff', 1, "2", 3.0)'


//.cpp

bool MyAPI::add(const FB::CatchAll& args)

{

const FB::VariantList& values = args.value;

std::string a = values[0].convert_cast<std::string>();

int         b = values[1].convert_case<int>();

//....


return true;

}


//

返回基本类型

所有被FB::variant支持的简单类型都可以直接返回。


返回容器

可以直接返回FB::VariantList 和 FB::VariantMap类型

return FB::variant_list_of(1)(2)(3);

return FB::variant_map_of(1, 2)(3, 4)(5, 6);



返回对象

返回的对象毕竟已经实现了FB::JSAPI,并且FB:JSAPIPtr应该作为返回类型。

return boost::make_shared<SomeObject>(m_browserHost),

其中SomeObject必须已经实现了JSAPI。

这篇关于FireBreath -- Summary--方法 属性 Attributes 事件和js的交互等的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/983598

相关文章

JS常用组件收集

收集了一些平时遇到的前端比较优秀的组件,方便以后开发的时候查找!!! 函数工具: Lodash 页面固定: stickUp、jQuery.Pin 轮播: unslider、swiper 开关: switch 复选框: icheck 气泡: grumble 隐藏元素: Headroom

禁止平板,iPad长按弹出默认菜单事件

通过监控按下抬起时间差来禁止弹出事件,把以下代码写在要禁止的页面的页面加载事件里面即可     var date;document.addEventListener('touchstart', event => {date = new Date().getTime();});document.addEventListener('touchend', event => {if (new

【C++】_list常用方法解析及模拟实现

相信自己的力量,只要对自己始终保持信心,尽自己最大努力去完成任何事,就算事情最终结果是失败了,努力了也不留遗憾。💓💓💓 目录   ✨说在前面 🍋知识点一:什么是list? •🌰1.list的定义 •🌰2.list的基本特性 •🌰3.常用接口介绍 🍋知识点二:list常用接口 •🌰1.默认成员函数 🔥构造函数(⭐) 🔥析构函数 •🌰2.list对象

在JS中的设计模式的单例模式、策略模式、代理模式、原型模式浅讲

1. 单例模式(Singleton Pattern) 确保一个类只有一个实例,并提供一个全局访问点。 示例代码: class Singleton {constructor() {if (Singleton.instance) {return Singleton.instance;}Singleton.instance = this;this.data = [];}addData(value)

浅谈主机加固,六种有效的主机加固方法

在数字化时代,数据的价值不言而喻,但随之而来的安全威胁也日益严峻。从勒索病毒到内部泄露,企业的数据安全面临着前所未有的挑战。为了应对这些挑战,一种全新的主机加固解决方案应运而生。 MCK主机加固解决方案,采用先进的安全容器中间件技术,构建起一套内核级的纵深立体防护体系。这一体系突破了传统安全防护的局限,即使在管理员权限被恶意利用的情况下,也能确保服务器的安全稳定运行。 普适主机加固措施:

webm怎么转换成mp4?这几种方法超多人在用!

webm怎么转换成mp4?WebM作为一种新兴的视频编码格式,近年来逐渐进入大众视野,其背后承载着诸多优势,但同时也伴随着不容忽视的局限性,首要挑战在于其兼容性边界,尽管WebM已广泛适应于众多网站与软件平台,但在特定应用环境或老旧设备上,其兼容难题依旧凸显,为用户体验带来不便,再者,WebM格式的非普适性也体现在编辑流程上,由于它并非行业内的通用标准,编辑过程中可能会遭遇格式不兼容的障碍,导致操

透彻!驯服大型语言模型(LLMs)的五种方法,及具体方法选择思路

引言 随着时间的发展,大型语言模型不再停留在演示阶段而是逐步面向生产系统的应用,随着人们期望的不断增加,目标也发生了巨大的变化。在短短的几个月的时间里,人们对大模型的认识已经从对其zero-shot能力感到惊讶,转变为考虑改进模型质量、提高模型可用性。 「大语言模型(LLMs)其实就是利用高容量的模型架构(例如Transformer)对海量的、多种多样的数据分布进行建模得到,它包含了大量的先验

【北交大信息所AI-Max2】使用方法

BJTU信息所集群AI_MAX2使用方法 使用的前提是预约到相应的算力卡,拥有登录权限的账号密码,一般为导师组共用一个。 有浏览器、ssh工具就可以。 1.新建集群Terminal 浏览器登陆10.126.62.75 (如果是1集群把75改成66) 交互式开发 执行器选Terminal 密码随便设一个(需记住) 工作空间:私有数据、全部文件 加速器选GeForce_RTX_2080_Ti

滚雪球学Java(87):Java事务处理:JDBC的ACID属性与实战技巧!真有两下子!

咦咦咦,各位小可爱,我是你们的好伙伴——bug菌,今天又来给大家普及Java SE啦,别躲起来啊,听我讲干货还不快点赞,赞多了我就有动力讲得更嗨啦!所以呀,养成先点赞后阅读的好习惯,别被干货淹没了哦~ 🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,助你一臂之力,带你早日登顶🚀,欢迎大家关注&&收藏!持续更新中,up!up!up!! 环境说明:Windows 10

Node.js学习记录(二)

目录 一、express 1、初识express 2、安装express 3、创建并启动web服务器 4、监听 GET&POST 请求、响应内容给客户端 5、获取URL中携带的查询参数 6、获取URL中动态参数 7、静态资源托管 二、工具nodemon 三、express路由 1、express中路由 2、路由的匹配 3、路由模块化 4、路由模块添加前缀 四、中间件