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

相关文章

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

SpringBoot实现数据库读写分离的3种方法小结

《SpringBoot实现数据库读写分离的3种方法小结》为了提高系统的读写性能和可用性,读写分离是一种经典的数据库架构模式,在SpringBoot应用中,有多种方式可以实现数据库读写分离,本文将介绍三... 目录一、数据库读写分离概述二、方案一:基于AbstractRoutingDataSource实现动态

Java中的String.valueOf()和toString()方法区别小结

《Java中的String.valueOf()和toString()方法区别小结》字符串操作是开发者日常编程任务中不可或缺的一部分,转换为字符串是一种常见需求,其中最常见的就是String.value... 目录String.valueOf()方法方法定义方法实现使用示例使用场景toString()方法方法

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

C#如何动态创建Label,及动态label事件

《C#如何动态创建Label,及动态label事件》:本文主要介绍C#如何动态创建Label,及动态label事件,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#如何动态创建Label,及动态label事件第一点:switch中的生成我们的label事件接着,

macOS无效Launchpad图标轻松删除的4 种实用方法

《macOS无效Launchpad图标轻松删除的4种实用方法》mac中不在appstore上下载的应用经常在删除后它的图标还残留在launchpad中,并且长按图标也不会出现删除符号,下面解决这个问... 在 MACOS 上,Launchpad(也就是「启动台」)是一个便捷的 App 启动工具。但有时候,应

SpringBoot日志配置SLF4J和Logback的方法实现

《SpringBoot日志配置SLF4J和Logback的方法实现》日志记录是不可或缺的一部分,本文主要介绍了SpringBoot日志配置SLF4J和Logback的方法实现,文中通过示例代码介绍的非... 目录一、前言二、案例一:初识日志三、案例二:使用Lombok输出日志四、案例三:配置Logback一

Python实现无痛修改第三方库源码的方法详解

《Python实现无痛修改第三方库源码的方法详解》很多时候,我们下载的第三方库是不会有需求不满足的情况,但也有极少的情况,第三方库没有兼顾到需求,本文将介绍几个修改源码的操作,大家可以根据需求进行选择... 目录需求不符合模拟示例 1. 修改源文件2. 继承修改3. 猴子补丁4. 追踪局部变量需求不符合很

mysql出现ERROR 2003 (HY000): Can‘t connect to MySQL server on ‘localhost‘ (10061)的解决方法

《mysql出现ERROR2003(HY000):Can‘tconnecttoMySQLserveron‘localhost‘(10061)的解决方法》本文主要介绍了mysql出现... 目录前言:第一步:第二步:第三步:总结:前言:当你想通过命令窗口想打开mysql时候发现提http://www.cpp