diff --git a/docs/.buildinfo b/docs/.buildinfo index d6a2a88..d558d7c 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: be625054012c59005cd92cdf8ec350c8 +config: 8626624fc90d1c39a94b9d4c064965c5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/commiting.rst.txt b/docs/_sources/commiting.rst.txt deleted file mode 100644 index 5fdf8b7..0000000 --- a/docs/_sources/commiting.rst.txt +++ /dev/null @@ -1,47 +0,0 @@ -Committing to zroya -=================== - -Changes in C files ------------------- - -1) Build Python extension from C source - - > python setup.py build - - Make sure there are no errors. - -2) Test it with existing tests - - > python setup.py test - - Make sure all tests passed - -3) Write your own tests when necessary. - -4) Change documentation. See Changes in Documentation - -5) Make stubs - - > python setup.py stubs - -Changes in Python files ------------------------ - -1) Test your changes with existing tests - - > python setup.py test - -2) Write your own tests when necessary. - -3) Change documentation. See Changes in Documentation - -4) Make stubs - - > python setup.py stubs - -Changes in documentation ------------------------- - -1) Build html documentation - - > python setup.py docs diff --git a/docs/_sources/documentation.rst.txt b/docs/_sources/documentation.rst.txt index e536f22..baa2fad 100644 --- a/docs/_sources/documentation.rst.txt +++ b/docs/_sources/documentation.rst.txt @@ -18,6 +18,12 @@ TemplateType .. autoclass:: zroya.TemplateType :members: +TemplateDuration +^^^^^^^^^^^^^^^^ + +.. autoclass:: zroya.TemplateDuration + :members: + Audio ----- diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 5a14e90..56ceb34 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: '', - VERSION: '0.2.2', + VERSION: '0.2.4', LANGUAGE: 'None', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', diff --git a/docs/commiting.html b/docs/commiting.html deleted file mode 100644 index 5d8d7d9..0000000 --- a/docs/commiting.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - Committing to zroya — Zroya 0.2 documentation - - - - - - - - - - - - - - - - - - -

-

-

-

- -

-

Committing to zroya¶

-

-

Changes in C files¶

-

Build Python extension from C source
-
-
> python setup.py build
-
Make sure there are no errors.
-
-
Test it with existing tests
-
-
> python setup.py test
-
Make sure all tests passed
-
-
Write your own tests when necessary.
-
Change documentation. See Changes in Documentation
-
Make stubs
-
-
> python setup.py stubs
-
-

-

-

-

Changes in Python files¶

-

Test your changes with existing tests
-
-
> python setup.py test
-
-
Write your own tests when necessary.
-
Change documentation. See Changes in Documentation
-
Make stubs
-
-
> python setup.py stubs
-
-

-

-

-

Changes in documentation¶

-

Build html documentation
-
-
> python setup.py docs
-
-

-

-

- - -

-

-

- -

-

- - - - - - - \ No newline at end of file diff --git a/docs/committing.html b/docs/committing.html index 358888b..0d03fd6 100644 --- a/docs/committing.html +++ b/docs/committing.html @@ -6,7 +6,7 @@ - Committing to zroya — Zroya 0.2.2 documentation + Committing to zroya — Zroya 0.2.4 documentation diff --git a/docs/content.html b/docs/content.html index f89d730..24590b9 100644 --- a/docs/content.html +++ b/docs/content.html @@ -6,7 +6,7 @@ - Tutorial — Zroya 0.2.2 documentation + Tutorial — Zroya 0.2.4 documentation diff --git a/docs/documentation.html b/docs/documentation.html index a4461ae..b1259f9 100644 --- a/docs/documentation.html +++ b/docs/documentation.html @@ -6,7 +6,7 @@ - API Documentation — Zroya 0.2.2 documentation + API Documentation — Zroya 0.2.4 documentation @@ -144,6 +144,16 @@

Template +
+`getDuration`()¶
+
Get duration of notification being shown before it is moved to Action Center.
+
+
Returns:
+
`zroya.TemplateDuration`: One of duration values.
+
+
+

`getExpiration`()¶
@@ -226,6 +236,17 @@
Template +
+`setDuration`()¶
+
Sets the duration of notification being shown before it is moved to Action Center.
+
+
Args:
+
duration (`zroya.TemplateDuration`): On of available duration values.Returns: +bool: Always returns True.
+
+
+

`setExpiration`()¶
@@ -367,6 +388,35 @@
TemplateType +
TemplateDuration ¶
+
+
+class `zroya.TemplateDuration`¶
+
All allowed values for `zroya.Template.setDuration()` and return values of +`zroya.Template.getDuration()`.
+
Duration sets the time notification is shown before it is moved to Action Center.
+
+
+`Long` = 'long'¶
+
Long duration.
+
+ +
+
+`Short` = 'short'¶
+
Shord duration
+
+ +
+
+`System` = 'system'¶
+
Default duration based on system configuration.
+
+ +
+
@@ -592,6 +642,7 @@
Table Of Contents

Functions

Template

TemplateType
+
TemplateDuration

Audio
diff --git a/docs/genindex.html b/docs/genindex.html index fb56db9..fa80b83 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -7,7 +7,7 @@ - Index — Zroya 0.2.2 documentation + Index — Zroya 0.2.4 documentation @@ -148,10 +148,12 @@
G

getAudioMode() (zroya.Template method)
-
getExpiration() (zroya.Template method) +
getDuration() (zroya.Template method)

+
getExpiration() (zroya.Template method) +

getFirstLine() (zroya.Template method)

getImage() (zroya.Template method) @@ -193,6 +195,10 @@
I

L
+ - +
+
Long (zroya.TemplateDuration attribute) +
+

Loop (zroya.AudioMode attribute)
@@ -221,22 +227,28 @@
S

setAttribution() (zroya.Template method)

setAudio() (zroya.Template method) +
+
setDuration() (zroya.Template method)

setExpiration() (zroya.Template method)

setFirstLine() (zroya.Template method)
-

setImage() (zroya.Template method)
+

setSecondLine() (zroya.Template method)

setThirdLine() (zroya.Template method) +
+
Short (zroya.TemplateDuration attribute)

show() (in module zroya)

Silence (zroya.AudioMode attribute) +
+
System (zroya.TemplateDuration attribute)

@@ -246,12 +258,14 @@
T

Template (class in zroya)
-
TemplateType (class in zroya) +
TemplateDuration (class in zroya)
-
Text1 (zroya.TemplateType attribute) +
TemplateType (class in zroya)

+
Text1 (zroya.TemplateType attribute) +

Text2 (zroya.TemplateType attribute)

Text3 (zroya.TemplateType attribute) diff --git a/docs/in_action.html b/docs/in_action.html index a9a7bb3..352c25a 100644 --- a/docs/in_action.html +++ b/docs/in_action.html @@ -6,7 +6,7 @@ - In Action — Zroya 0.2.2 documentation + In Action — Zroya 0.2.4 documentation diff --git a/docs/index.html b/docs/index.html index 45946be..8484906 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,7 +6,7 @@ - Welcome to Zroya’s documentation! — Zroya 0.2.2 documentation + Welcome to Zroya’s documentation! — Zroya 0.2.4 documentation diff --git a/docs/objects.inv b/docs/objects.inv index 6166fe4..9695039 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index 6f5fbbd..49160ed 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -6,7 +6,7 @@ - Python Module Index — Zroya 0.2.2 documentation + Python Module Index — Zroya 0.2.4 documentation diff --git a/docs/search.html b/docs/search.html index 788f462..ab90d21 100644 --- a/docs/search.html +++ b/docs/search.html @@ -6,7 +6,7 @@ - Search — Zroya 0.2.2 documentation + Search — Zroya 0.2.4 documentation diff --git a/docs/searchindex.js b/docs/searchindex.js index 034b74a..911bf3c 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["committing","content","documentation","in_action","index","tutorials/callbacks","tutorials/index","tutorials/installation","tutorials/template"],envversion:53,filenames:["committing.rst","content.rst","documentation.rst","in_action.rst","index.rst","tutorials\\callbacks.rst","tutorials\\index.rst","tutorials\\installation.rst","tutorials\\template.rst"],objects:{"":{zroya:[2,0,0,"-"]},"zroya.Audio":{Alarm10:[2,2,1,""],Alarm2:[2,2,1,""],Alarm3:[2,2,1,""],Alarm4:[2,2,1,""],Alarm5:[2,2,1,""],Alarm6:[2,2,1,""],Alarm7:[2,2,1,""],Alarm8:[2,2,1,""],Alarm9:[2,2,1,""],Alarm:[2,2,1,""],Call10:[2,2,1,""],Call2:[2,2,1,""],Call3:[2,2,1,""],Call4:[2,2,1,""],Call5:[2,2,1,""],Call6:[2,2,1,""],Call7:[2,2,1,""],Call8:[2,2,1,""],Call9:[2,2,1,""],Call:[2,2,1,""],Default:[2,2,1,""],IM:[2,2,1,""],Mail:[2,2,1,""],Reminder:[2,2,1,""]},"zroya.AudioMode":{Default:[2,2,1,""],Loop:[2,2,1,""],Silence:[2,2,1,""]},"zroya.DismissReason":{App:[2,2,1,""],Expired:[2,2,1,""],User:[2,2,1,""]},"zroya.Template":{addAction:[2,3,1,""],getAttribution:[2,3,1,""],getAudio:[2,3,1,""],getAudioMode:[2,3,1,""],getExpiration:[2,3,1,""],getFirstLine:[2,3,1,""],getImage:[2,3,1,""],getSecondLine:[2,3,1,""],getThirdLine:[2,3,1,""],setAttribution:[2,3,1,""],setAudio:[2,3,1,""],setExpiration:[2,3,1,""],setFirstLine:[2,3,1,""],setImage:[2,3,1,""],setSecondLine:[2,3,1,""],setThirdLine:[2,3,1,""]},"zroya.TemplateType":{ImageAndText1:[2,2,1,""],ImageAndText2:[2,2,1,""],ImageAndText3:[2,2,1,""],ImageAndText4:[2,2,1,""],Text1:[2,2,1,""],Text2:[2,2,1,""],Text3:[2,2,1,""],Text4:[2,2,1,""]},zroya:{Audio:[2,1,1,""],AudioMode:[2,1,1,""],DismissReason:[2,1,1,""],Template:[2,1,1,""],TemplateType:[2,1,1,""],hide:[2,4,1,""],init:[2,4,1,""],show:[2,4,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"boolean":6,"case":2,"class":[2,6,8],"default":2,"final":6,"function":[1,4,5,6,8],"import":[3,5,6,8],"int":2,"new":5,"return":[2,5,6,8],"true":2,Adding:[1,4],And:7,Are:4,But:[5,6,8],For:[7,8],One:[2,8],The:[2,5,6],Then:7,There:[4,6,8],Use:6,With:[1,4],abil:3,about:[6,8],accept:2,across:2,action:[1,2,4,6],action_id:5,activ:[2,5],add:[2,5,8],addact:[2,5,8],added:[5,8],adding:[6,8],after:8,aid:8,alarm10:2,alarm2:2,alarm3:2,alarm4:2,alarm5:2,alarm6:2,alarm7:2,alarm8:2,alarm9:2,alarm:2,aliv:5,all:[2,6,8],allow:[4,6],alwai:[5,6],ani:[2,5,6,8],annoi:[],answer:[5,8],anyth:6,api:[1,4],app:[2,6],app_nam:[2,6],applic:[2,5,6,8],arg:2,ask:[5,8],ask_templ:5,associ:6,attach:[1,4,8],attempt:2,attent:2,attribut:[2,6],audio:[1,4,8],audiomod:8,automat:[5,8],avail:[2,4,8],back:[1,2,4,5],base:[2,6],basic:6,becaus:8,befor:[2,6],being:2,besid:8,best:6,bit:[5,8],blank:6,bold:[2,3],bool:2,bore:8,bot:[5,8],bother:6,bright:[],build:[0,7],button:[2,5,8],call10:2,call2:2,call3:2,call4:[2,8],call5:2,call6:2,call7:2,call8:2,call9:2,call:[2,6],callabl:2,callback:[1,2,4,8],can:[2,5,6,8],caus:2,center:[2,8],chang:[1,4,5],check:5,choos:8,click:[1,2,3,4,8],clone:7,code:[1,3,4,5,6,8],com:7,come:8,commit:[1,4],company_nam:[2,6],compar:2,complet:2,configur:2,constructor:[2,6],contain:[2,3],cool:8,core:6,corner:6,correspond:2,count:2,creat:[2,4,5,6,8],current:[0,2],cute:8,debug:6,decid:4,def:[3,5],defin:[2,6,8],depend:5,descript:2,detail:3,did:[5,6],differ:[2,5],dismiss:[1,2,4,8],dismissreason:[1,4,5],distutil:7,doc:0,document:1,doe:[2,6,8],don:[6,8],down:6,due:2,each:[2,5,6,8],either:2,els:5,emoticon:5,empti:[2,8],enabl:6,enjoi:5,enough:8,enumer:2,error:[0,2,6],etc:[5,6],even:2,event:[2,5,8],everi:[5,8],everyth:6,exampl:[2,8],except:8,execut:5,exist:[0,2],expir:[1,2,4],explicit:2,explicitli:2,extens:[0,4],fail:[1,4,6,8],fals:[2,8],fart:[],featur:[2,8],field:6,file:[1,3,4,5],filenotfounderror:2,fill:6,find:6,fine:[5,8],fine_templ:5,fire:[2,5,8],first:[1,2,3,4,5,7],focu:6,follow:[2,6],font:3,form:6,forward:7,four:5,friendli:8,from:[0,1,2,4,5,8],further:[1,4,5],gener:2,get:[1,2,4,5],getattribut:2,getaudio:2,getaudiomod:2,getexpir:2,getfirstlin:[2,8],getimag:2,getsecondlin:[2,8],getthirdlin:[2,8],git:7,github:7,glad:5,global:5,got:[2,6],guess:[5,8],hand:[2,8],handler:[1,2,4],happen:[5,6],hard:6,has:[2,6],have:[5,6,7,8],head:6,hear:5,heart:8,help:6,hid:2,hidden:2,hide:[2,8],highlight:2,hold:[2,6],how:[2,5,6,8],html:0,http:7,imag:[1,2,4,5,6],imageandtext1:2,imageandtext2:2,imageandtext3:2,imageandtext4:[2,3,5,8],impress:5,index:2,inform:[5,6],init:[2,3,5,6],initi:[2,5,6,8],instal:[1,6],instanc:[2,6],interest:4,introduc:5,introduct:3,isn:[5,8],its:2,just:[3,7,8],keep:5,kei:8,know:5,label:2,larg:2,last:5,latest:7,leav:2,let:[5,8],level:5,librari:7,lifespan:8,line:[1,2,3,4,6],look:4,loop:[2,8],lot:6,mai:[2,8],mail:2,make:[0,5,6,8],malja:7,manag:8,manipul:2,manual:8,mean:2,meet:[5,8],method:2,millisecond:[2,8],mode:[2,8],modern:2,modul:2,moment:[4,6,8],more:[3,5,6,8],most:8,move:[2,8],much:8,multilin:[1,4],multipl:[1,4],mute:8,mybotcorp:6,name:[2,8],nativ:4,necessari:0,never:5,newer:2,next:8,nice:[5,8],nid:[2,5],nobo:6,note:[2,6],noth:5,notic:8,notif:[1,2,4,5,8],notification_id:[3,5],notifybot:[5,6,8],now:[5,6,8],number:[2,5,8],obtain:2,occur:2,off:8,ok_templ:5,old:8,older:8,on_:[2,5],on_act:[2,5],on_click:[2,3],on_dismiss:2,on_fail:2,onact:[2,5],onactionhandl:5,onc:2,onclick:[2,5],onclickhandl:[3,5],ondismiss:[2,5],ondismisshandl:5,one:[2,3,5,6,8],ones:8,onfail:[2,5],onfailhandl:5,onli:[2,6],other:[2,8],otherwis:2,our:6,owe:5,own:[0,2,8],packag:4,page:[0,3],paramet:[2,5,6],part:[2,5,8],pass:[2,5,6],path:2,pick:8,pip:[4,7],place:7,plai:[2,5,8],playback:2,pleas:[3,5,6,8],plenti:8,png:[3,5,8],point:8,posit:2,possibl:2,predefin:[2,6],prepar:5,pretti:[5,7,8],previou:[5,8],print:[2,3,6,8],probabl:8,product:6,product_nam:[2,6],progress:0,pypi:[4,7],python:[1,3,4,5,6,7],question:[5,8],rage:[],rais:2,randomli:2,readi:6,real:5,reason:[2,5],recommend:[4,8],record:[],regist:[2,5,6],regular:[2,3,5],remind:2,remov:[2,8],report:[6,8],repres:2,requir:[2,5,6],respect:8,respond:8,respons:5,result:[5,6],right:[4,6,8],run:[0,5],sadli:8,sai:6,said:8,same:5,screen:[2,6],scroll:6,second:[2,3,5,8],section:0,see:[0,2,3,5,6,8],select:[2,6,8],serv:6,set:[1,2,4,8],setattribut:2,setaudio:[2,8],setexpir:[2,8],setfirstlin:[2,3,5,6,8],setimag:[2,3,5,8],setsecondlin:[2,3,5,8],setthirdlin:[2,5,8],setup:[0,7],shorter:8,should:[2,6,8],shouldn:6,show:[1,2,3,4,5,8],shown:2,shut:8,side:[],silenc:[2,8],simpl:[1,4,5],simplest:6,singl:2,sleep:[3,5],snippet:3,some:[6,8],someth:[5,8],sooo:8,sorri:5,sound:[1,2,4,5,6],sourc:[0,1,4],stai:8,station:8,statu:6,step:[1,3,4],str:2,straight:7,string:[2,6,8],stub:0,sub_product:[2,6],success:2,summari:3,support:[2,8],sure:[0,6,8],system:[2,5,6,8],take:[4,5,8],teach:5,templat:[1,3,4,5],templatetyp:[3,5,6,8],test:0,text1:[2,3,5,6],text2:2,text3:2,text4:[2,8],text:[1,2,4],than:5,thei:[5,6,8],them:[5,6,8],thi:[0,2,3,5,6,8],thing:6,think:6,third:2,those:8,three:[2,8],through:[2,6],time:[1,2,3,4,5,6],toast:2,touch:2,trigger:2,troubleshoot:[1,4],tutori:[5,6,8],two:[2,5,8],type:[2,6,8],typeerror:2,uniqu:2,unless:5,unsupport:2,until:[2,8],usabl:8,usag:5,use:[6,7,8],used:2,user:[2,5,8],using:[2,6],v01:6,valid:2,valu:[2,5],vari:2,version:[2,6,7],visit:4,visual:7,wai:8,walk:6,want:[5,6,8],weather:8,went:[5,6],were:5,what:8,when:[0,2,5,8],which:[4,6,8],whole:5,window:[2,4,6,8],winsoundev:2,wish:5,won:8,wonder:8,work:[0,6,8],world:[1,4],would:[5,8],wouldn:8,wrap:2,write:0,wrong:5,yesterdai:[],you:[2,4,5,6,8],your:[0,6,8],zero:2,zroya:[1,2,3,5,6,7,8]},titles:["Committing to zroya","Tutorial","API Documentation","In Action","Welcome to Zroya\u2019s documentation!","Callbacks","First steps","Instalation","Further on templates"],titleterms:{"function":2,Adding:5,With:3,action:[3,5,8],api:2,attach:3,audio:2,audiomod:2,back:8,callback:[3,5],chang:[0,8],click:5,code:7,commit:0,dismiss:5,dismissreason:2,document:[0,2,4],expir:8,fail:5,file:0,first:6,from:7,further:8,get:8,handler:5,imag:[3,8],instal:[4,7],line:8,multilin:3,multipl:8,next:4,notif:[3,6],python:0,requir:4,set:6,show:6,simpl:3,sound:8,sourc:7,step:6,templat:[2,6,8],templatetyp:2,text:[6,8],time:8,troubleshoot:[6,8],tutori:[1,4],welcom:4,what:4,world:6,zroya:[0,4]}}) \ No newline at end of file +Search.setIndex({docnames:["committing","content","documentation","in_action","index","tutorials/callbacks","tutorials/index","tutorials/installation","tutorials/template"],envversion:53,filenames:["committing.rst","content.rst","documentation.rst","in_action.rst","index.rst","tutorials\\callbacks.rst","tutorials\\index.rst","tutorials\\installation.rst","tutorials\\template.rst"],objects:{"":{zroya:[2,0,0,"-"]},"zroya.Audio":{Alarm10:[2,2,1,""],Alarm2:[2,2,1,""],Alarm3:[2,2,1,""],Alarm4:[2,2,1,""],Alarm5:[2,2,1,""],Alarm6:[2,2,1,""],Alarm7:[2,2,1,""],Alarm8:[2,2,1,""],Alarm9:[2,2,1,""],Alarm:[2,2,1,""],Call10:[2,2,1,""],Call2:[2,2,1,""],Call3:[2,2,1,""],Call4:[2,2,1,""],Call5:[2,2,1,""],Call6:[2,2,1,""],Call7:[2,2,1,""],Call8:[2,2,1,""],Call9:[2,2,1,""],Call:[2,2,1,""],Default:[2,2,1,""],IM:[2,2,1,""],Mail:[2,2,1,""],Reminder:[2,2,1,""]},"zroya.AudioMode":{Default:[2,2,1,""],Loop:[2,2,1,""],Silence:[2,2,1,""]},"zroya.DismissReason":{App:[2,2,1,""],Expired:[2,2,1,""],User:[2,2,1,""]},"zroya.Template":{addAction:[2,3,1,""],getAttribution:[2,3,1,""],getAudio:[2,3,1,""],getAudioMode:[2,3,1,""],getDuration:[2,3,1,""],getExpiration:[2,3,1,""],getFirstLine:[2,3,1,""],getImage:[2,3,1,""],getSecondLine:[2,3,1,""],getThirdLine:[2,3,1,""],setAttribution:[2,3,1,""],setAudio:[2,3,1,""],setDuration:[2,3,1,""],setExpiration:[2,3,1,""],setFirstLine:[2,3,1,""],setImage:[2,3,1,""],setSecondLine:[2,3,1,""],setThirdLine:[2,3,1,""]},"zroya.TemplateDuration":{Long:[2,2,1,""],Short:[2,2,1,""],System:[2,2,1,""]},"zroya.TemplateType":{ImageAndText1:[2,2,1,""],ImageAndText2:[2,2,1,""],ImageAndText3:[2,2,1,""],ImageAndText4:[2,2,1,""],Text1:[2,2,1,""],Text2:[2,2,1,""],Text3:[2,2,1,""],Text4:[2,2,1,""]},zroya:{Audio:[2,1,1,""],AudioMode:[2,1,1,""],DismissReason:[2,1,1,""],Template:[2,1,1,""],TemplateDuration:[2,1,1,""],TemplateType:[2,1,1,""],hide:[2,4,1,""],init:[2,4,1,""],show:[2,4,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"boolean":6,"case":2,"class":[2,6,8],"default":2,"final":6,"function":[1,4,5,6,8],"import":[3,5,6,8],"int":2,"long":2,"new":5,"return":[2,5,6,8],"short":2,"true":2,Adding:[1,4],And:7,Are:4,But:[5,6,8],For:[7,8],One:[2,8],The:[2,5,6],Then:7,There:[4,6,8],Use:6,With:[1,4],abil:3,about:[6,8],accept:2,across:2,action:[1,2,4,6],action_id:5,activ:[2,5],add:[2,5,8],addact:[2,5,8],added:[5,8],adding:[6,8],after:8,aid:8,alarm10:2,alarm2:2,alarm3:2,alarm4:2,alarm5:2,alarm6:2,alarm7:2,alarm8:2,alarm9:2,alarm:2,aliv:5,all:[2,6,8],allow:[2,4,6],alwai:[2,5,6],ani:[2,5,6,8],answer:[5,8],anyth:6,api:[1,4],app:[2,6],app_nam:[2,6],applic:[2,5,6,8],arg:2,ask:[5,8],ask_templ:5,associ:6,attach:[1,4,8],attempt:2,attent:2,attribut:[2,6],audio:[1,4,8],audiomod:8,automat:[5,8],avail:[2,4,8],back:[1,2,4,5],base:[2,6],basic:6,becaus:8,befor:[2,6],being:2,besid:8,best:6,bit:[5,8],blank:6,bold:[2,3],bool:2,bore:8,bot:[5,8],bother:6,build:[0,7],button:[2,5,8],call10:2,call2:2,call3:2,call4:[2,8],call5:2,call6:2,call7:2,call8:2,call9:2,call:[2,6],callabl:2,callback:[1,2,4,8],can:[2,5,6,8],caus:2,center:[2,8],chang:[1,4,5],check:5,choos:8,click:[1,2,3,4,8],clone:7,code:[1,3,4,5,6,8],com:7,come:8,commit:[1,4],company_nam:[2,6],compar:2,complet:2,configur:2,constructor:[2,6],contain:[2,3],cool:8,core:6,corner:6,correspond:2,count:2,creat:[2,4,5,6,8],current:[0,2],cute:8,debug:6,decid:4,def:[3,5],defin:[2,6,8],depend:5,descript:2,detail:3,did:[5,6],differ:[2,5],dismiss:[1,2,4,8],dismissreason:[1,4,5],distutil:7,doc:0,document:1,doe:[2,6,8],don:[6,8],down:6,due:2,durat:2,each:[2,5,6,8],either:2,els:5,emoticon:5,empti:[2,8],enabl:6,enjoi:5,enough:8,enumer:2,error:[0,2,6],etc:[5,6],even:2,event:[2,5,8],everi:[5,8],everyth:6,exampl:[2,8],except:8,execut:5,exist:[0,2],expir:[1,2,4],explicit:2,explicitli:2,extens:[0,4],fail:[1,4,6,8],fals:[2,8],featur:[2,8],field:6,file:[1,3,4,5],filenotfounderror:2,fill:6,find:6,fine:[5,8],fine_templ:5,fire:[2,5,8],first:[1,2,3,4,5,7],focu:6,follow:[2,6],font:3,form:6,forward:7,four:5,friendli:8,from:[0,1,2,4,5,8],further:[1,4,5],gener:2,get:[1,2,4,5],getattribut:2,getaudio:2,getaudiomod:2,getdur:2,getexpir:2,getfirstlin:[2,8],getimag:2,getsecondlin:[2,8],getthirdlin:[2,8],git:7,github:7,glad:5,global:5,got:[2,6],guess:[5,8],hand:[2,8],handler:[1,2,4],happen:[5,6],hard:6,has:[2,6],have:[5,6,7,8],head:6,hear:5,heart:8,help:6,hid:2,hidden:2,hide:[2,8],highlight:2,hold:[2,6],how:[2,5,6,8],html:0,http:7,imag:[1,2,4,5,6],imageandtext1:2,imageandtext2:2,imageandtext3:2,imageandtext4:[2,3,5,8],impress:5,index:2,inform:[5,6],init:[2,3,5,6],initi:[2,5,6,8],instal:[1,6],instanc:[2,6],interest:4,introduc:5,introduct:3,isn:[5,8],its:2,just:[3,7,8],keep:5,kei:8,know:5,label:2,larg:2,last:5,latest:7,leav:2,let:[5,8],level:5,librari:7,lifespan:8,line:[1,2,3,4,6],look:4,loop:[2,8],lot:6,mai:[2,8],mail:2,make:[0,5,6,8],malja:7,manag:8,manipul:2,manual:8,mean:2,meet:[5,8],method:2,millisecond:[2,8],mode:[2,8],modern:2,modul:2,moment:[4,6,8],more:[3,5,6,8],most:8,move:[2,8],much:8,multilin:[1,4],multipl:[1,4],mute:8,mybotcorp:6,name:[2,8],nativ:4,necessari:0,never:5,newer:2,next:8,nice:[5,8],nid:[2,5],nobo:6,note:[2,6],noth:5,notic:8,notif:[1,2,4,5,8],notification_id:[3,5],notifybot:[5,6,8],now:[5,6,8],number:[2,5,8],obtain:2,occur:2,off:8,ok_templ:5,old:8,older:8,on_:[2,5],on_act:[2,5],on_click:[2,3],on_dismiss:2,on_fail:2,onact:[2,5],onactionhandl:5,onc:2,onclick:[2,5],onclickhandl:[3,5],ondismiss:[2,5],ondismisshandl:5,one:[2,3,5,6,8],ones:8,onfail:[2,5],onfailhandl:5,onli:[2,6],other:[2,8],otherwis:2,our:6,owe:5,own:[0,2,8],packag:4,page:[0,3],paramet:[2,5,6],part:[2,5,8],pass:[2,5,6],path:2,pick:8,pip:[4,7],place:7,plai:[2,5,8],playback:2,pleas:[3,5,6,8],plenti:8,png:[3,5,8],point:8,posit:2,possibl:2,predefin:[2,6],prepar:5,pretti:[5,7,8],previou:[5,8],print:[2,3,6,8],probabl:8,product:6,product_nam:[2,6],progress:0,pypi:[4,7],python:[1,3,4,5,6,7],question:[5,8],rais:2,randomli:2,readi:6,real:5,reason:[2,5],recommend:[4,8],regist:[2,5,6],regular:[2,3,5],remind:2,remov:[2,8],report:[6,8],repres:2,requir:[2,5,6],respect:8,respond:8,respons:5,result:[5,6],right:[4,6,8],run:[0,5],sadli:8,sai:6,said:8,same:5,screen:[2,6],scroll:6,second:[2,3,5,8],section:0,see:[0,2,3,5,6,8],select:[2,6,8],serv:6,set:[1,2,4,8],setattribut:2,setaudio:[2,8],setdur:2,setexpir:[2,8],setfirstlin:[2,3,5,6,8],setimag:[2,3,5,8],setsecondlin:[2,3,5,8],setthirdlin:[2,5,8],setup:[0,7],shord:2,shorter:8,should:[2,6,8],shouldn:6,show:[1,2,3,4,5,8],shown:2,shut:8,silenc:[2,8],simpl:[1,4,5],simplest:6,singl:2,sleep:[3,5],snippet:3,some:[6,8],someth:[5,8],sooo:8,sorri:5,sound:[1,2,4,5,6],sourc:[0,1,4],stai:8,station:8,statu:6,step:[1,3,4],str:2,straight:7,string:[2,6,8],stub:0,sub_product:[2,6],success:2,summari:3,support:[2,8],sure:[0,6,8],system:[2,5,6,8],take:[4,5,8],teach:5,templat:[1,3,4,5],templatetyp:[3,5,6,8],test:0,text1:[2,3,5,6],text2:2,text3:2,text4:[2,8],text:[1,2,4],than:5,thei:[5,6,8],them:[5,6,8],thi:[0,2,3,5,6,8],thing:6,think:6,third:2,those:8,three:[2,8],through:[2,6],time:[1,2,3,4,5,6],toast:2,touch:2,trigger:2,troubleshoot:[1,4],tutori:[5,6,8],two:[2,5,8],type:[2,6,8],typeerror:2,uniqu:2,unless:5,unsupport:2,until:[2,8],usabl:8,usag:5,use:[6,7,8],used:2,user:[2,5,8],using:[2,6],v01:6,valid:2,valu:[2,5],vari:2,version:[2,6,7],visit:4,visual:7,wai:8,walk:6,want:[5,6,8],weather:8,went:[5,6],were:5,what:8,when:[0,2,5,8],which:[4,6,8],whole:5,window:[2,4,6,8],winsoundev:2,wish:5,won:8,wonder:8,work:[0,6,8],world:[1,4],would:[5,8],wouldn:8,wrap:2,write:0,wrong:5,you:[2,4,5,6,8],your:[0,6,8],zero:2,zroya:[1,2,3,5,6,7,8]},titles:["Committing to zroya","Tutorial","API Documentation","In Action","Welcome to Zroya\u2019s documentation!","Callbacks","First steps","Instalation","Further on templates"],titleterms:{"function":2,Adding:5,With:3,action:[3,5,8],api:2,attach:3,audio:2,audiomod:2,back:8,callback:[3,5],chang:[0,8],click:5,code:7,commit:0,dismiss:5,dismissreason:2,document:[0,2,4],expir:8,fail:5,file:0,first:6,from:7,further:8,get:8,handler:5,imag:[3,8],instal:[4,7],line:8,multilin:3,multipl:8,next:4,notif:[3,6],python:0,requir:4,set:6,show:6,simpl:3,sound:8,sourc:7,step:6,templat:[2,6,8],templatedur:2,templatetyp:2,text:[6,8],time:8,troubleshoot:[6,8],tutori:[1,4],welcom:4,what:4,world:6,zroya:[0,4]}}) \ No newline at end of file diff --git a/docs/tutorials/callbacks.html b/docs/tutorials/callbacks.html index fe8d7d3..1d8f862 100644 --- a/docs/tutorials/callbacks.html +++ b/docs/tutorials/callbacks.html @@ -6,7 +6,7 @@ - Callbacks — Zroya 0.2.2 documentation + Callbacks — Zroya 0.2.4 documentation diff --git a/docs/tutorials/index.html b/docs/tutorials/index.html index 286f3af..512f619 100644 --- a/docs/tutorials/index.html +++ b/docs/tutorials/index.html @@ -6,7 +6,7 @@ - First steps — Zroya 0.2.2 documentation + First steps — Zroya 0.2.4 documentation diff --git a/docs/tutorials/installation.html b/docs/tutorials/installation.html index c333797..b6eb555 100644 --- a/docs/tutorials/installation.html +++ b/docs/tutorials/installation.html @@ -6,7 +6,7 @@ - Instalation — Zroya 0.2.2 documentation + Instalation — Zroya 0.2.4 documentation diff --git a/docs/tutorials/template.html b/docs/tutorials/template.html index 28cf1e1..901f1d5 100644 --- a/docs/tutorials/template.html +++ b/docs/tutorials/template.html @@ -6,7 +6,7 @@ - Further on templates — Zroya 0.2.2 documentation + Further on templates — Zroya 0.2.4 documentation diff --git a/docs_source/sphinx/source/documentation.rst b/docs_source/sphinx/source/documentation.rst index e536f22..baa2fad 100644 --- a/docs_source/sphinx/source/documentation.rst +++ b/docs_source/sphinx/source/documentation.rst @@ -18,6 +18,12 @@ TemplateType .. autoclass:: zroya.TemplateType :members: +TemplateDuration +^^^^^^^^^^^^^^^^ + +.. autoclass:: zroya.TemplateDuration + :members: + Audio ----- diff --git a/module/py_init.cpp b/module/py_init.cpp deleted file mode 100644 index 2c9e8d4..0000000 --- a/module/py_init.cpp +++ /dev/null @@ -1,151 +0,0 @@ -#include "py_init.h" -#include "init.h" -#include "utils.h" -#include "wintoastlib.h" -#include "py_template.h" -#include "event_handler.h" - -#include - -PyObject zroya_init(PyObject module, PyObject args, PyObject kwargs) { - - // List of all parameters this function may get - static char keywords[] = { (char)"app_name", (char)"company_name", (char)"product_name", (char)"sub_product", (char)"version", nullptr }; - - const char* app_name, company_name, product_name, sub_product, version; - - // Parse arguments - if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sssss", keywords, &app_name, &company_name, &product_name, &sub_product, &version)) { - PyErr_SetString(PyExc_ValueError, "all parameters must be string"); - return nullptr; - } - - if (strlen(app_name) == 0 || - strlen(company_name) == 0 || - strlen(product_name) == 0 || - strlen(sub_product) == 0 || - strlen(version) == 0) { - PyErr_SetString(PyExc_ValueError, "empty parameters are not allowed"); - return nullptr; - } - - // Initialize underlying library with provided parameters. - bool retcode = zroya::init( - std::string(app_name), - std::string(company_name), - std::string(product_name), - std::string(sub_product), - std::string(version) - ); - - if (retcode) { - Py_INCREF(Py_True); - return Py_True; - } - else { - Py_INCREF(Py_False); - return Py_False; - } - -} - -PyObject zroya_show(PyObject module, PyObject args, PyObject kwargs) { - - // List of all parameters thsi function accept - static char keywords[] = { (char)"template", (char)"on_click", (char)"on_action", (char)"on_dismiss", (char)"on_fail", nullptr }; - - PyObject toast = nullptr, on_click = nullptr, on_action = nullptr, on_dismiss = nullptr, on_fail = nullptr; - - // Parse arguments - if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|OOOO", keywords, &toast, &on_click, &on_action, &on_dismiss, &on_fail)) { - return nullptr; - } - - // Make sure template parameter is of zroya.Template type - if (strcmp(toast->ob_type->tp_name, "zroya.Template") != 0) { - PyErr_SetString(PyExc_ValueError, "first parameter must be of zroya.Template type."); - return nullptr; - } - - // Make sure WinToastLib is initialized - if (!WinToastLib::WinToast::instance()->isInitialized()) { - if (!zroya::init()) { - PyErr_SetString(PyExc_SystemError, "initialization failed"); - return nullptr; - } - } - - zroya_State state = static_cast(PyModule_GetState(module)); - - // Try to show notification and save its ID - INT64 notificationID = WinToastLib::WinToast::instance()->showToast((((zroya_Template)toast)->_template), static_cast(PyModule_GetState(module))->_handler ); - - if (notificationID > 0) { - Py_XINCREF(on_click); - Py_XINCREF(on_action); - Py_XINCREF(on_dismiss); - Py_XINCREF(on_fail); - - state->_handler->addCallbacks(notificationID, on_click, on_action, on_dismiss, on_fail); - } - - return PyLong_FromLongLong(notificationID); -} - -PyObject zroya_hide(PyObject module, PyObject arg, PyObject kwarg) { - - static char keywords[] = { (char)"nid" }; - - PyObject notificationID = nullptr; - - if (!PyArg_ParseTupleAndKeywords(arg, kwarg, "O", keywords, ¬ificationID )) { - return nullptr; - } - - - / - // Parse arguments - if (!PyTuple_Check(arg)) { - PyErr_SetString(PyExc_TypeError, "function takes tuple as parameter."); - return nullptr; - } - - // Exactly one parameter is required - if (PyTuple_Size(arg) != 1) { - PyErr_SetString(PyExc_ValueError, "function requires only one parameter."); - return nullptr; - }/ - - INT64 nID = -1; - - / - // Get number from PyObject representing tuple - PyObject tuple = PyTuple_GetItem(arg, 0); - notificationID = PyLong_AsLongLong(tuple); - / - - // Check if parameter is integer - if (!PyLong_Check(notificationID)) { - PyErr_SetString(PyExc_ValueError, "nid parameter is required to be an integer."); - return nullptr; - } - - // Get notification ID as integer - nID = PyLong_AsLongLong(notificationID); - - // Ignore unvalid values - if (nID < 0) { - PyErr_SetString(PyExc_ValueError, "nid may not be negative."); - return nullptr; - } - - if (WinToastLib::WinToast::instance()->hideToast(nID)) { - Py_INCREF(Py_True); - return Py_True; - } else { - Py_INCREF(Py_False); - return Py_False; - } - - -} diff --git a/module/py_init.h b/module/py_init.h deleted file mode 100644 index af14beb..0000000 --- a/module/py_init.h +++ /dev/null @@ -1,74 +0,0 @@ -#include - -#include "wintoastlib.h" -#include "event_handler.h" - -#ifdef __cplusplus - extern "C" { -#endif - - /** - * This file defines few core functions required for zroya module. - / - - /// Zroya global state - typedef struct { - /// Underhood library for notifications - WinToastLib::WinToast _win_toast; - /// My custom event handler - zroya::EventHandler _handler; - } zroya_State; - - PyDoc_STRVAR(zroya_initdoc, - "init(app_name, company_name, product_name, sub_product, version)\n" - "--\n\n" - "Initialize Zroya module. \n" - "\n" - "Note: You should call this function before any other manipulation with this module. \n" - "If you do not call this function explicitely, randomly generated strings will be used as default parameters. \n" - "\n" - "Args: \n" - "\tapp_name (str): Application name. \n\n" - "\tcompany_name (str): Part of unique ID created for this application. \n\n" - "\tproduct_name (str): Part of unique ID created for this application. \n\n" - "\tsub_product (str): Part of unique ID created for this application. \n\n" - "\tstr version (str): Part of unique ID created for this application. \n\n" - "\n" - "Returns: \n" - "\tbool: True if initialization is completed, False otherwise." - ); - PyObject zroya_init(PyObject self, PyObject args, PyObject kwargs); - - PyDoc_STRVAR(zroya_showdoc, - "show(template, on_click=None, on_action=None, on_dismiss=None, on_fail=None)\n" - "--\n\n" - "Create instance of notification template and show it. If any of on_ parameter is set, corresponding event is registered. See :doc:`tutorials/callbacks`.\n" - "\n" - "Args: \n" - "\ttemplate (:py:class:`zroya.Template`): Template instance. \n\n" - "\ton_click (callable): Callback for onClick event. Occurs when user activates a toast notification through a click or touch. \n\n" - "\ton_action (callable): Callback for onAction event. Occurs when user click on action button. \n\n" - "\ton_dismiss (callable): Callback for onDismiss event. Occurs when the notification leaves the screen, either by expiring or being explicitly dismissed by the user. \n\n" - "\ton_fail (callable): Callback for onFail event. Occurs when an error is caused when Windows attempts to raise a toast notification. \n\n" - "\n" - "Returns: \n" - "\tbool: Notification ID if notification was shown. False otherwise." - ); - PyObject zroya_show(PyObject module, PyObject args, PyObject kwargs); - - PyDoc_STRVAR(zroya_hidedoc, - "hide(nid)\n" - "--\n\n" - "Hide notification by ID. This will trigger onDismiss event.\n" - "\n" - "Args: \n" - "\tnid (int): Notification ID obtained from :py:func:`zroya.show` function. \n" - "\n" - "Returns: \n" - "\tbool: True if notification was hidden, false otherwise." - ); - PyObject zroya_hide(PyObject module, PyObject arg, PyObject kwarg); - -#ifdef __cplusplus - } -#endif \ No newline at end of file diff --git a/module/py_module.cpp b/module/py_module.cpp index 5ae399d..645b1a4 100644 --- a/module/py_module.cpp +++ b/module/py_module.cpp @@ -1,7 +1,129 @@ -#include - #include "py_module.h" -#include "wintoastlib.h" + +/** + * + / +PyObject zroya_init(PyObject module, PyObject args, PyObject kwargs) { + + // List of all parameters this function may get + static char keywords[] = { (char)"app_name", (char)"company_name", (char)"product_name", (char)"sub_product", (char)"version", nullptr }; + + const char app_name, company_name, product_name, sub_product, version; + + // Parse arguments + if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sssss", keywords, &app_name, &company_name, &product_name, &sub_product, &version)) { + PyErr_SetString(PyExc_ValueError, "all parameters must be string"); + return nullptr; + } + + if (strlen(app_name) == 0 || + strlen(company_name) == 0 || + strlen(product_name) == 0 || + strlen(sub_product) == 0 || + strlen(version) == 0) { + PyErr_SetString(PyExc_ValueError, "empty parameters are not allowed"); + return nullptr; + } + + // Initialize underlying library with provided parameters. + bool retcode = zroya::init( + std::string(app_name), + std::string(company_name), + std::string(product_name), + std::string(sub_product), + std::string(version) + ); + + if (retcode) { + Py_INCREF(Py_True); + return Py_True; + } + else { + Py_INCREF(Py_False); + return Py_False; + } + +} + +PyObject zroya_show(PyObject module, PyObject args, PyObject kwargs) { + + // List of all parameters thsi function accept + static char keywords[] = { (char)"template", (char)"on_click", (char)"on_action", (char)"on_dismiss", (char)"on_fail", nullptr }; + + PyObject toast = nullptr, on_click = nullptr, on_action = nullptr, on_dismiss = nullptr, on_fail = nullptr; + + // Parse arguments + if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|OOOO", keywords, &toast, &on_click, &on_action, &on_dismiss, &on_fail)) { + return nullptr; + } + + // Make sure template parameter is of zroya.Template type + if (strcmp(toast->ob_type->tp_name, "zroya.Template") != 0) { + PyErr_SetString(PyExc_ValueError, "first parameter must be of zroya.Template type."); + return nullptr; + } + + // Make sure WinToastLib is initialized + if (!WinToastLib::WinToast::instance()->isInitialized()) { + if (!zroya::init()) { + PyErr_SetString(PyExc_SystemError, "initialization failed"); + return nullptr; + } + } + + zroya_State state = static_cast(PyModule_GetState(module)); + + // Try to show notification and save its ID + INT64 notificationID = WinToastLib::WinToast::instance()->showToast((((zroya_Template)toast)->_template), static_cast(PyModule_GetState(module))->_handler); + + if (notificationID > 0) { + Py_XINCREF(on_click); + Py_XINCREF(on_action); + Py_XINCREF(on_dismiss); + Py_XINCREF(on_fail); + + state->_handler->addCallbacks(notificationID, on_click, on_action, on_dismiss, on_fail); + } + + return PyLong_FromLongLong(notificationID); +} + +PyObject zroya_hide(PyObject module, PyObject arg, PyObject kwarg) { + + static char keywords[] = { (char)"nid" }; + + PyObject notificationID = nullptr; + + if (!PyArg_ParseTupleAndKeywords(arg, kwarg, "O", keywords, ¬ificationID)) { + return nullptr; + } + + INT64 nID = -1; + + // Check if parameter is integer + if (!PyLong_Check(notificationID)) { + PyErr_SetString(PyExc_ValueError, "nid parameter is required to be an integer."); + return nullptr; + } + + // Get notification ID as integer + nID = PyLong_AsLongLong(notificationID); + + // Ignore unvalid values + if (nID < 0) { + PyErr_SetString(PyExc_ValueError, "nid may not be negative."); + return nullptr; + } + + if (WinToastLib::WinToast::instance()->hideToast(nID)) { + Py_INCREF(Py_True); + return Py_True; + } + else { + Py_INCREF(Py_False); + return Py_False; + } +} /// Clear zroya module int zroya_clear(PyObject self) { diff --git a/module/py_module.h b/module/py_module.h index 4dfb8c2..c9acca8 100644 --- a/module/py_module.h +++ b/module/py_module.h @@ -1,8 +1,11 @@ #pragma once -#include "py_init.h" -#include "py_template.h" +#include + +#include "wintoastlib.h" +#include "init.h" #include "event_handler.h" +#include "py_template.h" #include "py_utils.h" #ifdef __cplusplus @@ -20,6 +23,64 @@ extern "C" { "Library for creating native Windows 8, Window 9 and Windows 10 notifications. \n" ); + /// Zroya global state + typedef struct { + /// Underhood library for notifications + WinToastLib::WinToast _win_toast; + /// My custom event handler + zroya::EventHandler _handler; + } zroya_State; + + PyDoc_STRVAR(zroya_initdoc, + "init(app_name, company_name, product_name, sub_product, version)\n" + "--\n\n" + "Initialize Zroya module. \n" + "\n" + "Note: You should call this function before any other manipulation with this module. \n" + "If you do not call this function explicitely, randomly generated strings will be used as default parameters. \n" + "\n" + "Args: \n" + "\tapp_name (str): Application name. \n\n" + "\tcompany_name (str): Part of unique ID created for this application. \n\n" + "\tproduct_name (str): Part of unique ID created for this application. \n\n" + "\tsub_product (str): Part of unique ID created for this application. \n\n" + "\tstr version (str): Part of unique ID created for this application. \n\n" + "\n" + "Returns: \n" + "\tbool: True if initialization is completed, False otherwise." + ); + PyObject zroya_init(PyObject self, PyObject args, PyObject kwargs); + + PyDoc_STRVAR(zroya_showdoc, + "show(template, on_click=None, on_action=None, on_dismiss=None, on_fail=None)\n" + "--\n\n" + "Create instance of notification template and show it. If any of on_* parameter is set, corresponding event is registered. See :doc:`tutorials/callbacks`.\n" + "\n" + "Args: \n" + "\ttemplate (:py:class:`zroya.Template`): Template instance. \n\n" + "\ton_click (callable): Callback for onClick event. Occurs when user activates a toast notification through a click or touch. \n\n" + "\ton_action (callable): Callback for onAction event. Occurs when user click on action button. \n\n" + "\ton_dismiss (callable): Callback for onDismiss event. Occurs when the notification leaves the screen, either by expiring or being explicitly dismissed by the user. \n\n" + "\ton_fail (callable): Callback for onFail event. Occurs when an error is caused when Windows attempts to raise a toast notification. \n\n" + "\n" + "Returns: \n" + "\tbool: Notification ID if notification was shown. False otherwise." + ); + PyObject zroya_show(PyObject module, PyObject args, PyObject kwargs); + + PyDoc_STRVAR(zroya_hidedoc, + "hide(nid)\n" + "--\n\n" + "Hide notification by ID. This will trigger onDismiss event.\n" + "\n" + "Args: \n" + "\tnid (int): Notification ID obtained from :py:func:`zroya.show` function. \n" + "\n" + "Returns: \n" + "\tbool: True if notification was hidden, false otherwise." + ); + PyObject zroya_hide(PyObject module, PyObject arg, PyObject kwarg); + #ifdef __cplusplus } #endif \ No newline at end of file diff --git a/module/py_template.cpp b/module/py_template.cpp index ee37ea0..3321d1f 100644 --- a/module/py_template.cpp +++ b/module/py_template.cpp @@ -1,5 +1,3 @@ -#include - #include "py_template.h" #include "py_utils.h" @@ -367,6 +365,32 @@ PyObject zroya_template_addAction(zroya_Template self, PyObject arg, PyObject return Py_BuildValue("i", index); } +PyObject zroya_template_getAction(zroya_Template self, PyObject arg, PyObject kwarg) { + + // List of supported keywords + char keywords[] = { (char)"index", nullptr }; + + int index = -1; + + // Parse arguments + if (!PyArg_ParseTupleAndKeywords(arg, kwarg, "i", keywords, &index)) { + return nullptr; + } + + // Check if index is in range + if (index < 0 || index > self->_template->actionsCount() - 1) { + PyErr_SetString(PyExc_IndexError, "invalid action index"); + return nullptr; + } + + return Py_BuildValue("u", self->_template->actionLabel(index).c_str()); +} + +PyObject zroya_template_countActions(zroya_Template self, PyObject arg) { + return Py_BuildValue("i", self->_template->actionsCount()); +} + + PyObject zroya_template_setAttribution(zroya_Template self, PyObject arg, PyObject kwarg) { // List of supported keywords @@ -412,6 +436,100 @@ PyObject zroya_template_getAttribution(zroya_Template self, PyObject arg) { } +PyObject zroya_template_setDuration(zroya_Template self, PyObject arg, PyObject kwarg) { + + // List of supported keywords + char keywords[] = { (char)"duration", nullptr }; + + PyObject duration_obj = nullptr; + + // Parse arguments + if (!PyArg_ParseTupleAndKeywords(arg, kwarg, "O", keywords, &duration_obj)) { + return nullptr; + } + + // Import python module zroya + PyObject zroya_module = PyImport_ImportModule("zroya"); + if (!zroya_module) { + PyErr_SetString(PyExc_ImportError, "Unable to import zroya module"); + return nullptr; + } + + // Import zroya.TemplateDuration + PyObject zroya_TemplateDuration = PyObject_GetAttrString(zroya_module, "TemplateDuration"); + if (!zroya_TemplateDuration) { + PyErr_SetString(PyExc_NameError, "Class zroya.TemplateDuration doesn't exist"); + return nullptr; + } + + wchar_t duration = nullptr; + // Is it Enum zroya.TemplateDuration? + if (PyObject_IsInstance(duration_obj, zroya_TemplateDuration)) { + PyObject duration_value = PyObject_GetAttrString(duration_obj, "value"); + if (PyUnicode_Check(duration_value)) { + duration = PyUnicode_AsWideCharString(duration_value, nullptr); + } + Py_XDECREF(duration_value); + + } else { + + // Unsuported parameter type + PyErr_SetString(PyExc_TypeError, "duration parameter is not of type zroya.TemplateDuration"); + return nullptr; + + } + + // Is duration value "long"? + if (wcscmp(duration, L"long") == 0) { + self->_template->setDuration(WinToastLib::WinToastTemplate::Duration::Long); + // Is duration value "system"? + } else if(wcscmp(duration, L"system") == 0) { + self->_template->setDuration(WinToastLib::WinToastTemplate::Duration::System); + } else { + self->_template->setDuration(WinToastLib::WinToastTemplate::Duration::Short); + } + + Py_INCREF(Py_True); + return Py_True; +} + +PyObject zroya_template_getDuration(zroya_Template self, PyObject arg) { + + // Get duration + WinToastLib::WinToastTemplate::Duration duration = self->_template->duration(); + + // Import python module zroya + PyObject zroya_module = PyImport_ImportModule("zroya"); + if (!zroya_module) { + PyErr_SetString(PyExc_ImportError, "Unable to import zroya module"); + return nullptr; + } + + // Import zroya.TemplateDuration + PyObject zroya_TemplateDuration = PyObject_GetAttrString(zroya_module, "TemplateDuration"); + if (!zroya_TemplateDuration) { + PyErr_SetString(PyExc_NameError, "Class zroya.TemplateDuration doesn't exist"); + return nullptr; + } + + + // Return zroya.TemplateDuration instance based on current duration + switch (duration) { + case WinToastLib::WinToastTemplate::Duration::Long: + return PyObject_CallFunction(zroya_TemplateDuration, "u", L"long"); + break; + case WinToastLib::WinToastTemplate::Duration::Short: + return PyObject_CallFunction(zroya_TemplateDuration, "u", L"short"); + break; + default: + return PyObject_CallFunction(zroya_TemplateDuration, "u", L"system"); + } +} + +/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +// END OF METHODS DEFINITION +/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + PyObject zroya_template_new(PyTypeObject type, PyObject args, PyObject kwargs) { zroya_Template self = (zroya_Template )type->tp_alloc(type, 0); @@ -497,9 +615,15 @@ PyMethodDef zroya_template_methods[] = { { "getExpiration", (PyCFunction)zroya_template_getExpiration, METH_VARARGS, zroya_template_getExpirationdoc }, { "addAction", (PyCFunction)zroya_template_addAction, METH_VARARGS | METH_KEYWORDS, zroya_template_addActiondoc }, + { "getAction", (PyCFunction)zroya_template_getAction, METH_VARARGS | METH_KEYWORDS, zroya_template_getActiondoc }, + { "countActions", (PyCFunction)zroya_template_countActions, METH_VARARGS, zroya_template_countActionsdoc }, { "setAttribution", (PyCFunction)zroya_template_setAttribution, METH_VARARGS | METH_KEYWORDS, zroya_template_setAttributiondoc }, - { "getAttribution", (PyCFunction)zroya_template_getAttribution, METH_VARARGS | METH_KEYWORDS, zroya_template_getAttributiondoc }, + { "getAttribution", (PyCFunction)zroya_template_getAttribution, METH_VARARGS, zroya_template_getAttributiondoc }, + + { "setDuration", (PyCFunction)zroya_template_setDuration, METH_VARARGS | METH_KEYWORDS, zroya_template_setDurationdoc }, + { "getDuration", (PyCFunction)zroya_template_getDuration, METH_VARARGS, zroya_template_getDurationdoc }, + { nullptr, nullptr, 0, nullptr } }; diff --git a/module/py_template.h b/module/py_template.h index a66663e..bf968ab 100644 --- a/module/py_template.h +++ b/module/py_template.h @@ -1,6 +1,8 @@ #pragma once +#include #include + #include "wintoastlib.h" #ifdef __cplusplus @@ -237,6 +239,32 @@ ); PyObject zroya_template_addAction(zroya_Template self, PyObject arg, PyObject kwarg); + PyDoc_STRVAR(zroya_template_getActiondoc, + "getAction(index)\n" + "--\n\n" + "Get action text from it's index.\n" + "\n" + "Args: \n" + "\tindex (int): Action index. First added action has index 0, second 1 and so on. \n" + "\n" + "Throws: \n" + "\tIndexError When action with selected index does not exist." + "\n" + "Returns: \n" + "\tstr: Text of action with selected index." + ); + PyObject zroya_template_getAction(zroya_Template self, PyObject arg, PyObject kwarg); + + PyDoc_STRVAR(zroya_template_countActionsdoc, + "countActions()\n" + "--\n\n" + "Get number of actions added to template.\n" + "\n" + "Returns: \n" + "\tint: Number of actions within template." + ); + PyObject zroya_template_countActions(zroya_Template self, PyObject arg); + PyDoc_STRVAR(zroya_template_setAttributiondoc, "setAttribution(label)\n" "--\n\n" @@ -274,6 +302,28 @@ ); PyObject zroya_template_getAttribution(zroya_Template self, PyObject arg); + PyDoc_STRVAR(zroya_template_setDurationdoc, + "setDuration(duration)\n" + "--\n\n" + "Sets the duration of notification being shown before it is moved to Action Center. \n" + "\n" + "Args: \n" + "\tduration (:py:class:`zroya.TemplateDuration`): On of available duration values." + "Returns: \n" + "\tbool: Always returns True." + ); + PyObject zroya_template_setDuration(zroya_Template self, PyObject arg, PyObject kwarg); + + PyDoc_STRVAR(zroya_template_getDurationdoc, + "getDuration()\n" + "--\n\n" + "Get duration of notification being shown before it is moved to Action Center. \n" + "\n" + "Returns: \n" + "\t:py:class:`zroya.TemplateDuration`: One of duration values." + ); + PyObject zroya_template_getDuration(zroya_Template self, PyObject arg); + /// Create new empty zroya.Template object without inner values set up. PyObject zroya_template_new(PyTypeObject type, PyObject args, PyObject kwargs); diff --git a/module/wintoastlib.cpp b/module/wintoastlib.cpp index 73ff4b7..2914fa8 100644 --- a/module/wintoastlib.cpp +++ b/module/wintoastlib.cpp @@ -6,9 +6,9 @@ #pragma comment(lib,"user32") #ifdef NDEBUG -#define DEBUG_MSG(str) do { } while ( false ) -#else -#define DEBUG_MSG(str) do { std::wcout << str << std::endl; } while( false ) + #define DEBUG_MSG(str) do { } while ( false ) + #else + #define DEBUG_MSG(str) do { std::wcout << str << std::endl; } while( false ) #endif // Thanks: https://stackoverflow.com/a/36545162/4297146 @@ -20,100 +20,97 @@ typedef LONG NTSTATUS, PNTSTATUS; typedef NTSTATUS(WINAPI RtlGetVersionPtr)(PRTL_OSVERSIONINFOW); RTL_OSVERSIONINFOW GetRealOSVersion() { - HMODULE hMod = ::GetModuleHandleW(L"ntdll.dll"); - if (hMod) { - RtlGetVersionPtr fxPtr = (RtlGetVersionPtr)::GetProcAddress(hMod, "RtlGetVersion"); - if (fxPtr != nullptr) { - RTL_OSVERSIONINFOW rovi = { 0 }; - rovi.dwOSVersionInfoSize = sizeof(rovi); - if (STATUS_SUCCESS == fxPtr(&rovi)) { - return rovi; - } - } - } - RTL_OSVERSIONINFOW rovi = { 0 }; - return rovi; + HMODULE hMod = ::GetModuleHandleW(L"ntdll.dll"); + if (hMod) { + RtlGetVersionPtr fxPtr = (RtlGetVersionPtr)::GetProcAddress(hMod, "RtlGetVersion"); + if (fxPtr != nullptr) { + RTL_OSVERSIONINFOW rovi = { 0 }; + rovi.dwOSVersionInfoSize = sizeof(rovi); + if (STATUS_SUCCESS == fxPtr(&rovi)) { + return rovi; + } + } + } + RTL_OSVERSIONINFOW rovi = { 0 }; + return rovi; } // Quickstart: Handling toast activations from Win32 apps in Windows 10 // https://blogs.msdn.microsoft.com/tiles_and_toasts/2015/10/16/quickstart-handling-toast-activations-from-win32-apps-in-windows-10/ -namespace WinToastLib { - namespace DllImporter { - - // Function load a function from library - template - HRESULT loadFunctionFromLibrary(HINSTANCE library, LPCSTR name, Function &func) { - if (!library) { - return E_INVALIDARG; - } - func = reinterpret_cast(GetProcAddress(library, name)); - return (func != nullptr) ? S_OK : E_FAIL; - } +using namespace WinToastLib; +namespace DllImporter { + + // Function load a function from library + template + HRESULT loadFunctionFromLibrary(HINSTANCE library, LPCSTR name, Function &func) { + if (!library) { + return E_INVALIDARG; + } + func = reinterpret_cast(GetProcAddress(library, name)); + return (func != nullptr) ? S_OK : E_FAIL; + } - typedef HRESULT(FAR STDAPICALLTYPE f_SetCurrentProcessExplicitAppUserModelID)(__in PCWSTR AppID); - typedef HRESULT(FAR STDAPICALLTYPE f_PropVariantToString)(_In_ REFPROPVARIANT propvar, _Out_writes_(cch) PWSTR psz, _In_ UINT cch); - typedef HRESULT(FAR STDAPICALLTYPE *f_RoGetActivationFactory)(_In_ HSTRING activatableClassId, _In_ REFIID iid, _COM_Outptr_ void ** factory); - typedef HRESULT(FAR STDAPICALLTYPE f_WindowsCreateStringReference)(_In_reads_opt_(length + 1) PCWSTR sourceString, UINT32 length, _Out_ HSTRING_HEADER hstringHeader, _Outptr_result_maybenull_ _Result_nullonfailure_ HSTRING * string); - typedef PCWSTR(FAR STDAPICALLTYPE f_WindowsGetStringRawBuffer)(_In_ HSTRING string, _Out_ UINT32 length); - typedef HRESULT(FAR STDAPICALLTYPE f_WindowsDeleteString)(_In_opt_ HSTRING string); + typedef HRESULT(FAR STDAPICALLTYPE f_SetCurrentProcessExplicitAppUserModelID)(__in PCWSTR AppID); + typedef HRESULT(FAR STDAPICALLTYPE f_PropVariantToString)(_In_ REFPROPVARIANT propvar, _Out_writes_(cch) PWSTR psz, _In_ UINT cch); + typedef HRESULT(FAR STDAPICALLTYPE f_RoGetActivationFactory)(_In_ HSTRING activatableClassId, _In_ REFIID iid, _COM_Outptr_ void ** factory); + typedef HRESULT(FAR STDAPICALLTYPE f_WindowsCreateStringReference)(_In_reads_opt_(length + 1) PCWSTR sourceString, UINT32 length, _Out_ HSTRING_HEADER hstringHeader, _Outptr_result_maybenull_ _Result_nullonfailure_ HSTRING * string); + typedef PCWSTR(FAR STDAPICALLTYPE f_WindowsGetStringRawBuffer)(_In_ HSTRING string, _Out_ UINT32 length); + typedef HRESULT(FAR STDAPICALLTYPE f_WindowsDeleteString)(_In_opt_ HSTRING string); - static f_SetCurrentProcessExplicitAppUserModelID SetCurrentProcessExplicitAppUserModelID; - static f_PropVariantToString PropVariantToString; - static f_RoGetActivationFactory RoGetActivationFactory; - static f_WindowsCreateStringReference WindowsCreateStringReference; - static f_WindowsGetStringRawBuffer WindowsGetStringRawBuffer; - static f_WindowsDeleteString WindowsDeleteString; + static f_SetCurrentProcessExplicitAppUserModelID SetCurrentProcessExplicitAppUserModelID; + static f_PropVariantToString PropVariantToString; + static f_RoGetActivationFactory RoGetActivationFactory; + static f_WindowsCreateStringReference WindowsCreateStringReference; + static f_WindowsGetStringRawBuffer WindowsGetStringRawBuffer; + static f_WindowsDeleteString WindowsDeleteString; - template - _Check_return_ __inline HRESULT _1_GetActivationFactory(_In_ HSTRING activatableClassId, _COM_Outptr_ T factory) { - return RoGetActivationFactory(activatableClassId, IID_INS_ARGS(factory)); - } + template + _Check_return_ __inline HRESULT _1_GetActivationFactory(_In_ HSTRING activatableClassId, _COM_Outptr_ T factory) { + return RoGetActivationFactory(activatableClassId, IID_INS_ARGS(factory)); + } - template - inline HRESULT Wrap_GetActivationFactory(_In_ HSTRING activatableClassId, _Inout_ Details::ComPtrRef factory) throw() { - return _1_GetActivationFactory(activatableClassId, factory.ReleaseAndGetAddressOf()); - } + template + inline HRESULT Wrap_GetActivationFactory(_In_ HSTRING activatableClassId, _Inout_ Details::ComPtrRef factory) throw() { + return _1_GetActivationFactory(activatableClassId, factory.ReleaseAndGetAddressOf()); + } - inline HRESULT initialize() { - HINSTANCE LibShell32 = LoadLibraryW(L"SHELL32.DLL"); - HRESULT hr = loadFunctionFromLibrary(LibShell32, "SetCurrentProcessExplicitAppUserModelID", SetCurrentProcessExplicitAppUserModelID); + inline HRESULT initialize() { + HINSTANCE LibShell32 = LoadLibraryW(L"SHELL32.DLL"); + HRESULT hr = loadFunctionFromLibrary(LibShell32, "SetCurrentProcessExplicitAppUserModelID", SetCurrentProcessExplicitAppUserModelID); + if (SUCCEEDED(hr)) { + HINSTANCE LibPropSys = LoadLibraryW(L"PROPSYS.DLL"); + hr = loadFunctionFromLibrary(LibPropSys, "PropVariantToString", PropVariantToString); if (SUCCEEDED(hr)) { - HINSTANCE LibPropSys = LoadLibraryW(L"PROPSYS.DLL"); - hr = loadFunctionFromLibrary(LibPropSys, "PropVariantToString", PropVariantToString); - if (SUCCEEDED(hr)) { - HINSTANCE LibComBase = LoadLibraryW(L"COMBASE.DLL"); - const bool succeded = SUCCEEDED(loadFunctionFromLibrary(LibComBase, "RoGetActivationFactory", RoGetActivationFactory)) - && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsCreateStringReference", WindowsCreateStringReference)) - && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsGetStringRawBuffer", WindowsGetStringRawBuffer)) - && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsDeleteString", WindowsDeleteString)); - return succeded ? S_OK : E_FAIL; - } + HINSTANCE LibComBase = LoadLibraryW(L"COMBASE.DLL"); + const bool succeded = SUCCEEDED(loadFunctionFromLibrary(LibComBase, "RoGetActivationFactory", RoGetActivationFactory)) + && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsCreateStringReference", WindowsCreateStringReference)) + && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsGetStringRawBuffer", WindowsGetStringRawBuffer)) + && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsDeleteString", WindowsDeleteString)); + return succeded ? S_OK : E_FAIL; } - return hr; } + return hr; } } -using namespace WinToastLib; - class WinToastStringWrapper { public: WinToastStringWrapper(_In_reads_(length) PCWSTR stringRef, _In_ UINT32 length) throw() { - HRESULT hr = WinToastLib::DllImporter::WindowsCreateStringReference(stringRef, length, &_header, &_hstring); + HRESULT hr = DllImporter::WindowsCreateStringReference(stringRef, length, &_header, &_hstring); if (!SUCCEEDED(hr)) { RaiseException(static_cast(STATUS_INVALID_PARAMETER), EXCEPTION_NONCONTINUABLE, 0, nullptr); } } WinToastStringWrapper(_In_ const std::wstring &stringRef) throw() { - HRESULT hr = WinToastLib::DllImporter::WindowsCreateStringReference(stringRef.c_str(), static_cast(stringRef.length()), &_header, &_hstring); + HRESULT hr = DllImporter::WindowsCreateStringReference(stringRef.c_str(), static_cast(stringRef.length()), &_header, &_hstring); if (FAILED(hr)) { RaiseException(static_cast(STATUS_INVALID_PARAMETER), EXCEPTION_NONCONTINUABLE, 0, nullptr); } } ~WinToastStringWrapper() { - WinToastLib::DllImporter::WindowsDeleteString(_hstring); + DllImporter::WindowsDeleteString(_hstring); } inline HSTRING Get() const throw() { return _hstring; } private: @@ -181,161 +178,168 @@ class MyDateTime : public IReference } }; -namespace WinToastLib { - namespace Util { - inline HRESULT defaultExecutablePath(_In_ WCHAR path, _In_ DWORD nSize = MAX_PATH) { - DWORD written = GetModuleFileNameExW(GetCurrentProcess(), nullptr, path, nSize); - DEBUG_MSG("Default executable path: " << path); - return (written > 0) ? S_OK : E_FAIL; - } +namespace Util { + inline HRESULT defaultExecutablePath(_In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { + DWORD written = GetModuleFileNameExW(GetCurrentProcess(), nullptr, path, nSize); + DEBUG_MSG("Default executable path: " << path); + return (written > 0) ? S_OK : E_FAIL; + } - inline HRESULT defaultShellLinksDirectory(_In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { - DWORD written = GetEnvironmentVariableW(L"APPDATA", path, nSize); - HRESULT hr = written > 0 ? S_OK : E_INVALIDARG; - if (SUCCEEDED(hr)) { - errno_t result = wcscat_s(path, nSize, DEFAULT_SHELL_LINKS_PATH); - hr = (result == 0) ? S_OK : E_INVALIDARG; - DEBUG_MSG("Default shell link path: " << path); - } - return hr; + inline HRESULT defaultShellLinksDirectory(_In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { + DWORD written = GetEnvironmentVariableW(L"APPDATA", path, nSize); + HRESULT hr = written > 0 ? S_OK : E_INVALIDARG; + if (SUCCEEDED(hr)) { + errno_t result = wcscat_s(path, nSize, DEFAULT_SHELL_LINKS_PATH); + hr = (result == 0) ? S_OK : E_INVALIDARG; + DEBUG_MSG("Default shell link path: " << path); } + return hr; + } - inline HRESULT defaultShellLinkPath(const std::wstring& appname, _In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { - HRESULT hr = defaultShellLinksDirectory(path, nSize); - if (SUCCEEDED(hr)) { - const std::wstring appLink(appname + DEFAULT_LINK_FORMAT); - errno_t result = wcscat_s(path, nSize, appLink.c_str()); - hr = (result == 0) ? S_OK : E_INVALIDARG; - DEBUG_MSG("Default shell link file path: " << path); - } - return hr; + inline HRESULT defaultShellLinkPath(const std::wstring& appname, _In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { + HRESULT hr = defaultShellLinksDirectory(path, nSize); + if (SUCCEEDED(hr)) { + const std::wstring appLink(appname + DEFAULT_LINK_FORMAT); + errno_t result = wcscat_s(path, nSize, appLink.c_str()); + hr = (result == 0) ? S_OK : E_INVALIDARG; + DEBUG_MSG("Default shell link file path: " << path); } + return hr; + } - inline PCWSTR AsString(ComPtr &xmlDocument) { - HSTRING xml; - ComPtr ser; - HRESULT hr = xmlDocument.As(&ser); - hr = ser->GetXml(&xml); - if (SUCCEEDED(hr)) - return WinToastLib::DllImporter::WindowsGetStringRawBuffer(xml, NULL); - return NULL; - } + inline PCWSTR AsString(ComPtr &xmlDocument) { + HSTRING xml; + ComPtr ser; + HRESULT hr = xmlDocument.As(&ser); + hr = ser->GetXml(&xml); + if (SUCCEEDED(hr)) + return DllImporter::WindowsGetStringRawBuffer(xml, NULL); + return NULL; + } - inline PCWSTR AsString(HSTRING hstring) { - return WinToastLib::DllImporter::WindowsGetStringRawBuffer(hstring, NULL); - } + inline PCWSTR AsString(HSTRING hstring) { + return DllImporter::WindowsGetStringRawBuffer(hstring, NULL); + } - inline HRESULT setNodeStringValue(const std::wstring& string, IXmlNode node, IXmlDocument xml) { - ComPtr textNode; - HRESULT hr = xml->CreateTextNode(WinToastStringWrapper(string).Get(), &textNode); + inline HRESULT setNodeStringValue(const std::wstring& string, IXmlNode node, IXmlDocument xml) { + ComPtr textNode; + HRESULT hr = xml->CreateTextNode( WinToastStringWrapper(string).Get(), &textNode); + if (SUCCEEDED(hr)) { + ComPtr stringNode; + hr = textNode.As(&stringNode); if (SUCCEEDED(hr)) { - ComPtr stringNode; - hr = textNode.As(&stringNode); - if (SUCCEEDED(hr)) { - ComPtr appendedChild; - hr = node->AppendChild(stringNode.Get(), &appendedChild); - } + ComPtr appendedChild; + hr = node->AppendChild(stringNode.Get(), &appendedChild); } - return hr; } + return hr; + } - inline HRESULT setEventHandlers(_In_ IToastNotification* notification, _In_ std::shared_ptr eventHandler, _In_ INT64 expirationTime, INT64 notificationID) { - EventRegistrationToken activatedToken, dismissedToken, failedToken; - HRESULT hr = notification->add_Activated( - Callback < Implements < RuntimeClassFlags, - ITypedEventHandler> >( + /* Zroya: INT64 notificationID parameter added / + inline HRESULT setEventHandlers(_In_ IToastNotification notification, _In_ std::shared_ptr eventHandler, _In_ INT64 expirationTime, INT64 notificationID) { + EventRegistrationToken activatedToken, dismissedToken, failedToken; + /* Zroya: Added notificationID parameter to lambda's capture clausule. / + HRESULT hr = notification->add_Activated( + Callback < Implements < RuntimeClassFlags, + ITypedEventHandler> >( [eventHandler, notificationID](IToastNotification, IInspectable* inspectable) - { - IToastActivatedEventArgs activatedEventArgs; - HRESULT hr = inspectable->QueryInterface(&activatedEventArgs); - if (SUCCEEDED(hr)) { - HSTRING argumentsHandle; - hr = activatedEventArgs->get_Arguments(&argumentsHandle); + { + IToastActivatedEventArgs activatedEventArgs; + HRESULT hr = inspectable->QueryInterface(&activatedEventArgs); if (SUCCEEDED(hr)) { - PCWSTR arguments = Util::AsString(argumentsHandle); - if (arguments && arguments) { - eventHandler->toastActivated((int)wcstol(arguments, NULL, 10), notificationID); - return S_OK; + HSTRING argumentsHandle; + hr = activatedEventArgs->get_Arguments(&argumentsHandle); + if (SUCCEEDED(hr)) { + PCWSTR arguments = Util::AsString(argumentsHandle); + if (arguments && arguments) { + /* Zroya: Added notificationID to call / + eventHandler->toastActivated((int)wcstol(arguments, NULL, 10), notificationID); + return S_OK; + } } } - } - eventHandler->toastActivated(notificationID); - return S_OK; - }).Get(), &activatedToken); + / Zroya: Added notificationID to call / + eventHandler->toastActivated(notificationID); + return S_OK; + }).Get(), &activatedToken); + if (SUCCEEDED(hr)) { + / Zroya: Added notificationID parameter to lambda's capture clausule. / + hr = notification->add_Dismissed(Callback < Implements < RuntimeClassFlags, + ITypedEventHandler> >( + [eventHandler, expirationTime, notificationID](IToastNotification, IToastDismissedEventArgs* e) + { + ToastDismissalReason reason; + if (SUCCEEDED(e->get_Reason(&reason))) + { + if (reason == ToastDismissalReason_UserCanceled && expirationTime && MyDateTime::Now() >= expirationTime) + reason = ToastDismissalReason_TimedOut; + + /* Zroya: Added notificationID to call / + eventHandler->toastDismissed(static_cast(reason), notificationID); + } + return S_OK; + }).Get(), &dismissedToken); if (SUCCEEDED(hr)) { - hr = notification->add_Dismissed(Callback < Implements < RuntimeClassFlags, - ITypedEventHandler> >( - [eventHandler, expirationTime, notificationID](IToastNotification, IToastDismissedEventArgs* e) + /* Zroya: Added notificationID parameter to lambda's capture clausule. / + hr = notification->add_Failed(Callback < Implements < RuntimeClassFlags, + ITypedEventHandler> >( + [eventHandler, notificationID](IToastNotification, IToastFailedEventArgs) { - ToastDismissalReason reason; - if (SUCCEEDED(e->get_Reason(&reason))) - { - if (reason == ToastDismissalReason_UserCanceled && expirationTime && MyDateTime::Now() >= expirationTime) - reason = ToastDismissalReason_TimedOut; - eventHandler->toastDismissed(static_cast(reason), notificationID); - } + / Zroya: Added notificationID to call / + eventHandler->toastFailed(notificationID); return S_OK; - }).Get(), &dismissedToken); - if (SUCCEEDED(hr)) { - hr = notification->add_Failed(Callback < Implements < RuntimeClassFlags, - ITypedEventHandler> >( - [eventHandler, notificationID](IToastNotification, IToastFailedEventArgs) - { - eventHandler->toastFailed(notificationID); - return S_OK; - }).Get(), &failedToken); - } + }).Get(), &failedToken); } - return hr; } + return hr; + } - inline HRESULT addAttribute(_In_ IXmlDocument xml, const std::wstring &name, IXmlNamedNodeMap attributeMap) { - ComPtr srcAttribute; - HRESULT hr = xml->CreateAttribute(WinToastStringWrapper(name).Get(), &srcAttribute); + inline HRESULT addAttribute(_In_ IXmlDocument xml, const std::wstring &name, IXmlNamedNodeMap attributeMap) { + ComPtr srcAttribute; + HRESULT hr = xml->CreateAttribute(WinToastStringWrapper(name).Get(), &srcAttribute); + if (SUCCEEDED(hr)) { + ComPtr node; + hr = srcAttribute.As(&node); if (SUCCEEDED(hr)) { - ComPtr node; - hr = srcAttribute.As(&node); - if (SUCCEEDED(hr)) { - ComPtr pNode; - hr = attributeMap->SetNamedItem(node.Get(), &pNode); - } + ComPtr pNode; + hr = attributeMap->SetNamedItem(node.Get(), &pNode); } - return hr; } + return hr; + } - inline HRESULT createElement(_In_ IXmlDocument xml, _In_ const std::wstring& root_node, _In_ const std::wstring& element_name, _In_ const std::vector& attribute_names) { - ComPtr rootList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(root_node).Get(), &rootList); + inline HRESULT createElement(_In_ IXmlDocument xml, _In_ const std::wstring& root_node, _In_ const std::wstring& element_name, _In_ const std::vector& attribute_names) { + ComPtr rootList; + HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(root_node).Get(), &rootList); + if (SUCCEEDED(hr)) { + ComPtr root; + hr = rootList->Item(0, &root); if (SUCCEEDED(hr)) { - ComPtr root; - hr = rootList->Item(0, &root); + ComPtr audioElement; + hr = xml->CreateElement(WinToastStringWrapper(element_name).Get(), &audioElement); if (SUCCEEDED(hr)) { - ComPtr audioElement; - hr = xml->CreateElement(WinToastStringWrapper(element_name).Get(), &audioElement); + ComPtr audioNodeTmp; + hr = audioElement.As(&audioNodeTmp); if (SUCCEEDED(hr)) { - ComPtr audioNodeTmp; - hr = audioElement.As(&audioNodeTmp); + ComPtr audioNode; + hr = root->AppendChild(audioNodeTmp.Get(), &audioNode); if (SUCCEEDED(hr)) { - ComPtr audioNode; - hr = root->AppendChild(audioNodeTmp.Get(), &audioNode); + ComPtr attributes; + hr = audioNode->get_Attributes(&attributes); if (SUCCEEDED(hr)) { - ComPtr attributes; - hr = audioNode->get_Attributes(&attributes); - if (SUCCEEDED(hr)) { - for (auto it : attribute_names) { - hr = addAttribute(xml, it, attributes.Get()); - } + for (auto it : attribute_names) { + hr = addAttribute(xml, it, attributes.Get()); } } } } } } - return hr; } + return hr; } } @@ -348,9 +352,9 @@ WinToast::WinToast() : _isInitialized(false), _hasCoInitialized(false) { - if (!isCompatible()) { - DEBUG_MSG(L"Warning: Your system is not compatible with this library "); - } + if (!isCompatible()) { + DEBUG_MSG(L"Warning: Your system is not compatible with this library "); + } } WinToast::~WinToast() { @@ -370,23 +374,23 @@ void WinToast::setAppUserModelId(_In_ const std::wstring& aumi) { } bool WinToast::isCompatible() { - WinToastLib::DllImporter::initialize(); - return !((WinToastLib::DllImporter::SetCurrentProcessExplicitAppUserModelID == nullptr) - || (WinToastLib::DllImporter::PropVariantToString == nullptr) - || (WinToastLib::DllImporter::RoGetActivationFactory == nullptr) - || (WinToastLib::DllImporter::WindowsCreateStringReference == nullptr) - || (WinToastLib::DllImporter::WindowsDeleteString == nullptr)); + DllImporter::initialize(); + return !((DllImporter::SetCurrentProcessExplicitAppUserModelID == nullptr) + || (DllImporter::PropVariantToString == nullptr) + || (DllImporter::RoGetActivationFactory == nullptr) + || (DllImporter::WindowsCreateStringReference == nullptr) + || (DllImporter::WindowsDeleteString == nullptr)); } -bool WinToastLib::WinToast::supportModernFeatures() { - RTL_OSVERSIONINFOW tmp = GetRealOSVersion(); - return tmp.dwMajorVersion > 6; +bool WinToastLib::WinToast::isSupportingModernFeatures() { + RTL_OSVERSIONINFOW tmp = GetRealOSVersion(); + return tmp.dwMajorVersion > 6; } std::wstring WinToast::configureAUMI(_In_ const std::wstring &companyName, - _In_ const std::wstring &productName, - _In_ const std::wstring &subProduct, - _In_ const std::wstring &versionInformation) + _In_ const std::wstring &productName, + _In_ const std::wstring &subProduct, + _In_ const std::wstring &versionInformation) { std::wstring aumi = companyName; aumi += L"." + productName; @@ -434,18 +438,34 @@ enum WinToast::ShortcutResult WinToast::createShortcut() { return wasChanged ? SHORTCUT_WAS_CHANGED : SHORTCUT_UNCHANGED; hr = createShellLinkHelper(); - if (SUCCEEDED(hr)) - return SHORTCUT_WAS_CREATED; - return SHORTCUT_CREATE_FAILED; + return SUCCEEDED(hr) ? SHORTCUT_WAS_CREATED : SHORTCUT_CREATE_FAILED; } -bool WinToast::initialize() { +bool WinToast::initialize(_Out_ WinToastError error) { _isInitialized = false; + setError(error, WinToastError::NoError); - if (createShortcut() < 0) + if (!isCompatible()) { + setError(error, WinToastError::SystemNotSupported); + DEBUG_MSG(L"Error: system not supported."); return false; + } + + + if (_aumi.empty() || _appName.empty()) { + setError(error, WinToastError::InvalidParameters); + DEBUG_MSG(L"Error while initializing, did you set up a valid AUMI and App name?"); + return false; + } + + if (createShortcut() < 0) { + setError(error, WinToastError::ShellLinkNotCreated); + DEBUG_MSG(L"Error while attaching the AUMI to the current proccess =("); + return false; + } - if (FAILED(WinToastLib::DllImporter::SetCurrentProcessExplicitAppUserModelID(_aumi.c_str()))) { + if (FAILED(DllImporter::SetCurrentProcessExplicitAppUserModelID(_aumi.c_str()))) { + setError(error, WinToastError::InvalidAppUserModelID); DEBUG_MSG(L"Error while attaching the AUMI to the current proccess =("); return false; } @@ -454,9 +474,22 @@ bool WinToast::initialize() { return _isInitialized; } +bool WinToast::isInitialized() const { + return _isInitialized; +} + +const std::wstring& WinToast::appName() const { + return _appName; +} + +const std::wstring& WinToast::appUserModelId() const { + return _aumi; +} + + HRESULT WinToast::validateShellLinkHelper(_Out_ bool& wasChanged) { - WCHAR path[MAX_PATH] = { L'\0' }; - WinToastLib::Util::defaultShellLinkPath(_appName, path); + WCHAR path[MAX_PATH] = { L'\0' }; + Util::defaultShellLinkPath(_appName, path); // Check if the file exist DWORD attr = GetFileAttributesW(path); if (attr >= 0xFFFFFFF) { @@ -485,7 +518,7 @@ HRESULT WinToast::validateShellLinkHelper(_Out_ bool& wasChanged) { hr = propertyStore->GetValue(PKEY_AppUserModel_ID, &appIdPropVar); if (SUCCEEDED(hr)) { WCHAR AUMI[MAX_PATH]; - hr = WinToastLib::DllImporter::PropVariantToString(appIdPropVar, AUMI, MAX_PATH); + hr = DllImporter::PropVariantToString(appIdPropVar, AUMI, MAX_PATH); wasChanged = false; if (FAILED(hr) || _aumi != AUMI) { // AUMI Changed for the same app, let's update the current value! =) @@ -514,10 +547,10 @@ HRESULT WinToast::validateShellLinkHelper(_Out_ bool& wasChanged) { HRESULT WinToast::createShellLinkHelper() { - WCHAR exePath[MAX_PATH]{ L'\0' }; - WCHAR slPath[MAX_PATH]{ L'\0' }; - WinToastLib::Util::defaultShellLinkPath(_appName, slPath); - WinToastLib::Util::defaultExecutablePath(exePath); + WCHAR exePath[MAX_PATH]{L'\0'}; + WCHAR slPath[MAX_PATH]{L'\0'}; + Util::defaultShellLinkPath(_appName, slPath); + Util::defaultExecutablePath(exePath); ComPtr shellLink; HRESULT hr = CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&shellLink)); if (SUCCEEDED(hr)) { @@ -554,29 +587,31 @@ HRESULT WinToast::createShellLinkHelper() { return hr; } -INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler) { - +INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler, _Out_ WinToastError* error) { + setError(error, WinToastError::NoError); INT64 id = -1; if (!isInitialized()) { - DEBUG_MSG("Error when launching the toast. WinToast is not initialized =("); + setError(error, WinToastError::NotInitialized); + DEBUG_MSG("Error when launching the toast. WinToast is not initialized."); return id; } if (!handler) { - DEBUG_MSG("Error when launching the toast. handler cannot be null."); + setError(error, WinToastError::InvalidHandler); + DEBUG_MSG("Error when launching the toast. Handler cannot be null."); return id; } ComPtr notificationManager; - HRESULT hr = WinToastLib::DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager); + HRESULT hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager); if (SUCCEEDED(hr)) { ComPtr notifier; hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier); if (SUCCEEDED(hr)) { ComPtr notificationFactory; - hr = WinToastLib::DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotification).Get(), ¬ificationFactory); + hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotification).Get(), ¬ificationFactory); if (SUCCEEDED(hr)) { - ComPtr xmlDocument; - HRESULT hr = notificationManager->GetTemplateContent(ToastTemplateType(toast.type()), &xmlDocument); + ComPtr xmlDocument; + HRESULT hr = notificationManager->GetTemplateContent(ToastTemplateType(toast.type()), &xmlDocument); if (SUCCEEDED(hr)) { const int fieldsCount = toast.textFieldsCount(); for (int i = 0; i < fieldsCount && SUCCEEDED(hr); i++) { @@ -584,7 +619,7 @@ INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHan } // Modern feature are supported Windows > Windows 10 - if (SUCCEEDED(hr) && supportModernFeatures()) { + if (SUCCEEDED(hr) && isSupportingModernFeatures()) { // Note that we do this after using toast.textFieldsCount() to // iterate/fill the template's text fields, since we're adding yet another text field. @@ -601,11 +636,16 @@ INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHan } if (SUCCEEDED(hr)) { - hr = (toast.audioPath().empty() && toast.audioOption() == WinToastTemplate::Default) + hr = (toast.audioPath().empty() && toast.audioOption() == WinToastTemplate::AudioOption::Default) ? hr : setAudioFieldHelper(xmlDocument.Get(), toast.audioPath(), toast.audioOption()); } - } - else { + + if (SUCCEEDED(hr) && toast.duration() != WinToastTemplate::Duration::System) { + hr = addDurationHelper(xmlDocument.Get(), + (toast.duration() == WinToastTemplate::Duration::Short) ? L"short" : L"long"); + } + + } else { DEBUG_MSG("Modern features (Actions/Sounds/Attributes) not supported in this os version"); } @@ -621,19 +661,28 @@ INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHan expiration = expirationDateTime; hr = notification->put_ExpirationTime(&expirationDateTime); } - + + /* Zroya: GUID generating move up here. Event handler now knows the notification ID / GUID guid; hr = CoCreateGuid(&guid); if (SUCCEEDED(hr)) { - hr = WinToastLib::Util::setEventHandlers(notification.Get(), std::shared_ptr(handler), expiration, guid.Data1); + / Zroya: Added GUID (NotificationID) to call / + hr = Util::setEventHandlers(notification.Get(), std::shared_ptr(handler), expiration, guid.Data1); + if (FAILED(hr)) { + setError(error, WinToastError::InvalidHandler); + } } + if (SUCCEEDED(hr)) { if (SUCCEEDED(hr)) { id = guid.Data1; _buffer[id] = notification; - DEBUG_MSG("xml: " << WinToastLib::Util::AsString(xmlDocument)); + DEBUG_MSG("xml: " << Util::AsString(xmlDocument)); hr = notifier->Show(notification.Get()); + if (FAILED(hr)) { + setError(error, WinToastError::NotDisplayed); + } } } } @@ -646,48 +695,43 @@ INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHan return FAILED(hr) ? -1 : id; } -ComPtr WinToast::notifier(_In_ bool succeded) const { - ComPtr notificationManager; - ComPtr notifier; - HRESULT hr = WinToastLib::DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager); - if (SUCCEEDED(hr)) { - hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier); - } - succeded = SUCCEEDED(hr); - return notifier; +ComPtr WinToast::notifier(_In_ bool succeded) const { + ComPtr notificationManager; + ComPtr notifier; + HRESULT hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager); + if (SUCCEEDED(hr)) { + hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier); + } + succeded = SUCCEEDED(hr); + return notifier; } - bool WinToast::hideToast(_In_ INT64 id) { if (!isInitialized()) { DEBUG_MSG("Error when hiding the toast. WinToast is not initialized."); return false; } - const bool find = _buffer.find(id) != _buffer.end(); - if (find) { - - bool succeded = false; - ComPtr notify = notifier(&succeded); - - if (succeded) { + if (find) { + bool succeded = false; + ComPtr notify = notifier(&succeded); + if (succeded) { notify->Hide(_buffer[id].Get()); - } - - _buffer.erase(id); - } + } + _buffer.erase(id); + } return find; } void WinToast::clear() { - bool succeded = false; - ComPtr notify = notifier(&succeded); - if (succeded) { - auto end = _buffer.end(); - for (auto it = _buffer.begin(); it != end; ++it) { - notify->Hide(it->second.Get()); - } - } + bool succeded = false; + ComPtr notify = notifier(&succeded); + if (succeded) { + auto end = _buffer.end(); + for (auto it = _buffer.begin(); it != end; ++it) { + notify->Hide(it->second.Get()); + } + } _buffer.clear(); } @@ -699,7 +743,7 @@ void WinToast::clear() { // the toast's text fields or getting a count of them. // HRESULT WinToast::setAttributionTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& text) { - WinToastLib::Util::createElement(xml, L"binding", L"text", { L"placement" }); + Util::createElement(xml, L"binding", L"text", { L"placement" }); ComPtr nodeList; HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"text").Get(), &nodeList); if (SUCCEEDED(hr)) { @@ -719,7 +763,7 @@ HRESULT WinToast::setAttributionTextFieldHelper(_In_ IXmlDocument xml, _In_ con if (FAILED(hr) || !editedNode) { continue; } - hr = WinToastLib::Util::setNodeStringValue(L"attribution", editedNode.Get(), xml); + hr = Util::setNodeStringValue(L"attribution", editedNode.Get(), xml); if (SUCCEEDED(hr)) { return setTextFieldHelper(xml, text, i); } @@ -732,6 +776,28 @@ HRESULT WinToast::setAttributionTextFieldHelper(_In_ IXmlDocument xml, _In_ con return hr; } +HRESULT WinToast::addDurationHelper(_In_ IXmlDocument xml, _In_ const std::wstring& duration) { + ComPtr nodeList; + HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList); + if (SUCCEEDED(hr)) { + UINT32 length; + hr = nodeList->get_Length(&length); + if (SUCCEEDED(hr)) { + ComPtr toastNode; + hr = nodeList->Item(0, &toastNode); + if (SUCCEEDED(hr)) { + ComPtr toastElement; + hr = toastNode.As(&toastElement); + if (SUCCEEDED(hr)) { + hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(), + WinToastStringWrapper(duration).Get()); + } + } + } + } + return hr; +} + HRESULT WinToast::setTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& text, _In_ int pos) { ComPtr nodeList; HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"text").Get(), &nodeList); @@ -739,31 +805,30 @@ HRESULT WinToast::setTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wst ComPtr node; hr = nodeList->Item(pos, &node); if (SUCCEEDED(hr)) { - hr = WinToastLib::Util::setNodeStringValue(text, node.Get(), xml); + hr = Util::setNodeStringValue(text, node.Get(), xml); } } return hr; } -HRESULT WinToast::setImageFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& path) { +HRESULT WinToast::setImageFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& path) { wchar_t imagePath[MAX_PATH] = L"file:///"; HRESULT hr = StringCchCatW(imagePath, MAX_PATH, path.c_str()); - if (SUCCEEDED(hr)) { ComPtr nodeList; HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"image").Get(), &nodeList); if (SUCCEEDED(hr)) { ComPtr node; hr = nodeList->Item(0, &node); - if (SUCCEEDED(hr)) { + if (SUCCEEDED(hr)) { ComPtr attributes; hr = node->get_Attributes(&attributes); if (SUCCEEDED(hr)) { ComPtr editedNode; hr = attributes->GetNamedItem(WinToastStringWrapper(L"src").Get(), &editedNode); if (SUCCEEDED(hr)) { - WinToastLib::Util::setNodeStringValue(imagePath, editedNode.Get(), xml); + Util::setNodeStringValue(imagePath, editedNode.Get(), xml); } } } @@ -777,7 +842,7 @@ HRESULT WinToast::setAudioFieldHelper(_In_ IXmlDocument xml, _In_ const std::ws if (!path.empty()) attrs.push_back(L"src"); if (option == WinToastTemplate::AudioOption::Loop) attrs.push_back(L"loop"); if (option == WinToastTemplate::AudioOption::Silent) attrs.push_back(L"silent"); - WinToastLib::Util::createElement(xml, L"toast", L"audio", attrs); + Util::createElement(xml, L"toast", L"audio", attrs); ComPtr nodeList; HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"audio").Get(), &nodeList); @@ -793,27 +858,27 @@ HRESULT WinToast::setAudioFieldHelper(_In_ IXmlDocument xml, _In_ const std::ws if (SUCCEEDED(hr)) { hr = attributes->GetNamedItem(WinToastStringWrapper(L"src").Get(), &editedNode); if (SUCCEEDED(hr)) { - WinToastLib::Util::setNodeStringValue(path, editedNode.Get(), xml); + hr = Util::setNodeStringValue(path, editedNode.Get(), xml); } } } - // - // These options are mutually exclusive - // - switch (option) { - case WinToastTemplate::AudioOption::Loop: - hr = attributes->GetNamedItem(WinToastStringWrapper(L"loop").Get(), &editedNode); - if (SUCCEEDED(hr)) { - WinToastLib::Util::setNodeStringValue(L"true", editedNode.Get(), xml); - } - break; - case WinToastTemplate::AudioOption::Silent: - hr = attributes->GetNamedItem(WinToastStringWrapper(L"silent").Get(), &editedNode); - if (SUCCEEDED(hr)) { - WinToastLib::Util::setNodeStringValue(L"true", editedNode.Get(), xml); + + if (SUCCEEDED(hr)) { + switch (option) { + case WinToastTemplate::AudioOption::Loop: + hr = attributes->GetNamedItem(WinToastStringWrapper(L"loop").Get(), &editedNode); + if (SUCCEEDED(hr)) { + hr = Util::setNodeStringValue(L"true", editedNode.Get(), xml); + } + break; + case WinToastTemplate::AudioOption::Silent: + hr = attributes->GetNamedItem(WinToastStringWrapper(L"silent").Get(), &editedNode); + if (SUCCEEDED(hr)) { + hr = Util::setNodeStringValue(L"true", editedNode.Get(), xml); + } + default: + break; } - default: - break; } } } @@ -822,8 +887,8 @@ HRESULT WinToast::setAudioFieldHelper(_In_ IXmlDocument xml, _In_ const std::ws } HRESULT WinToast::addActionHelper(_In_ IXmlDocument xml, _In_ const std::wstring& content, _In_ const std::wstring& arguments) { - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"actions").Get(), &nodeList); + ComPtr nodeList; + HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"actions").Get(), &nodeList); if (SUCCEEDED(hr)) { UINT32 length; hr = nodeList->get_Length(&length); @@ -831,8 +896,7 @@ HRESULT WinToast::addActionHelper(_In_ IXmlDocument xml, _In_ const std::wstrin ComPtr actionsNode; if (length > 0) { hr = nodeList->Item(0, &actionsNode); - } - else { + } else { hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList); if (SUCCEEDED(hr)) { hr = nodeList->get_Length(&length); @@ -843,9 +907,9 @@ HRESULT WinToast::addActionHelper(_In_ IXmlDocument xml, _In_ const std::wstrin ComPtr toastElement; hr = toastNode.As(&toastElement); if (SUCCEEDED(hr)) - hr = toastElement->SetAttribute(WinToastStringWrapper(L"template").Get(), WinToastStringWrapper(L"ToastGeneric").Get()); + hr = toastElement->SetAttribute(WinToastStringWrapper(L"template").Get(), WinToastStringWrapper(L"ToastGeneric").Get()); if (SUCCEEDED(hr)) - hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(), WinToastStringWrapper(L"long").Get()); + hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(), WinToastStringWrapper(L"long").Get()); if (SUCCEEDED(hr)) { ComPtr actionsElement; hr = xml->CreateElement(WinToastStringWrapper(L"actions").Get(), &actionsElement); @@ -882,10 +946,15 @@ HRESULT WinToast::addActionHelper(_In_ IXmlDocument xml, _In_ const std::wstrin return hr; } +void WinToast::setError(_Out_ WinToastError* error, _In_ WinToastError value) { + if (error) { + error = value; + } +} + WinToastTemplate::WinToastTemplate(_In_ WinToastTemplateType type) : _type(type) { - static const std::size_t TextFieldsCount[] = { 1, 2, 2, 3, 1, 2, 2, 3 }; - _textFields = std::vector(TextFieldsCount[_type], L""); - _imagePath = L""; + static const std::size_t TextFieldsCount[] = { 1, 2, 2, 3, 1, 2, 2, 3}; + _textFields = std::vector(TextFieldsCount[type], L""); } WinToastTemplate::~WinToastTemplate() { @@ -904,15 +973,75 @@ void WinToastTemplate::setAudioPath(_In_ const std::wstring& audioPath) { _audioPath = audioPath; } -void WinToastTemplate::setAudioOption(_In_ const WinToastTemplate::AudioOption & audioOption) { +void WinToastTemplate::setAudioOption(_In_ WinToastTemplate::AudioOption audioOption) { _audioOption = audioOption; } +void WinToastTemplate::setDuration(_In_ Duration duration) { + _duration = duration; +} + +void WinToastTemplate::setExpiration(_In_ INT64 millisecondsFromNow) { + _expiration = millisecondsFromNow; +} + void WinToastTemplate::setAttributionText(_In_ const std::wstring& attributionText) { _attributionText = attributionText; } void WinToastTemplate::addAction(_In_ const std::wstring & label) { - _actions.push_back(label); + _actions.push_back(label); +} + +std::size_t WinToastTemplate::textFieldsCount() const { + return _textFields.size(); +} + +std::size_t WinToastTemplate::actionsCount() const { + return _actions.size(); +} + +bool WinToastTemplate::hasImage() const { + return _type < WinToastTemplateType::Text01; } + +const std::vector& WinToastTemplate::textFields() const { + return _textFields; +} + +const std::wstring& WinToastTemplate::textField(_In_ TextField pos) const { + return _textFields[pos]; +} + +const std::wstring& WinToastTemplate::actionLabel(_In_ int pos) const { + return _actions[pos]; +} + +const std::wstring& WinToastTemplate::imagePath() const { + return _imagePath; +} + +const std::wstring& WinToastTemplate::audioPath() const { + return _audioPath; +} + +const std::wstring& WinToastTemplate::attributionText() const { + return _attributionText; +} + +INT64 WinToastTemplate::expiration() const { + return _expiration; +} + +WinToastTemplate::WinToastTemplateType WinToastTemplate::type() const { + return _type; +} + +WinToastTemplate::AudioOption WinToastTemplate::audioOption() const { + return _audioOption; +} + +WinToastTemplate::Duration WinToastTemplate::duration() const { + return _duration; +} \ No newline at end of file diff --git a/module/wintoastlib.h b/module/wintoastlib.h index 499676f..84ecf32 100644 --- a/module/wintoastlib.h +++ b/module/wintoastlib.h @@ -35,14 +35,20 @@ namespace WinToastLib { ApplicationHidden = ToastDismissalReason::ToastDismissalReason_ApplicationHidden, TimedOut = ToastDismissalReason::ToastDismissalReason_TimedOut }; + + / Zroya: INT64 notificationID parameter added / virtual void toastActivated(INT64 notificationID) const = 0; + / Zroya: INT64 notificationID parameter added / virtual void toastActivated(int actionIndex, INT64 notificationID) const = 0; + / Zroya: INT64 notificationID parameter added / virtual void toastDismissed(WinToastDismissalReason state, INT64 notificationID) const = 0; + / Zroya: INT64 notificationID parameter added / virtual void toastFailed(INT64 notificationID) const = 0; }; class WinToastTemplate { public: + enum Duration { System, Short, Long }; enum AudioOption { Default = 0, Silent = 1, Loop = 2 }; enum TextField { FirstLine = 0, SecondLine, ThirdLine }; enum WinToastTemplateType { @@ -57,61 +63,55 @@ namespace WinToastLib { WinToastTemplateTypeCount }; - WinToastTemplate(_In_ WinToastTemplateType type = ImageAndText02); + WinToastTemplate(_In_ WinToastTemplateType type = WinToastTemplateType::ImageAndText02); ~WinToastTemplate(); - void setTextField(_In_ const std::wstring& txt, _In_ TextField pos); - void setImagePath(_In_ const std::wstring& imgPath); - void setAudioPath(_In_ const std::wstring& audioPath); - void setAudioOption(_In_ const WinToastTemplate::AudioOption& audioOption); - void setAttributionText(_In_ const std::wstring & attributionText); - void addAction(_In_ const std::wstring& label); - inline void setExpiration(_In_ INT64 millisecondsFromNow) { _expiration = millisecondsFromNow; } - inline int textFieldsCount() const { return static_cast(_textFields.size()); } - inline int actionsCount() const { return static_cast(_actions.size()); } - inline bool hasImage() const { return _type < Text01; } - inline std::vector textFields() const { return _textFields; } - inline std::wstring textField(_In_ TextField pos) const { return _textFields[pos]; } - inline std::wstring actionLabel(_In_ int pos) const { return _actions[pos]; } - inline std::wstring imagePath() const { return _imagePath; } - inline std::wstring audioPath() const { return _audioPath; } - inline std::wstring attributionText() const { return _attributionText; } - inline INT64 expiration() const { return _expiration; } - inline WinToastTemplateType type() const { return _type; } - inline WinToastTemplate::AudioOption audioOption() const { return _audioOption; } - + void setTextField(_In_ const std::wstring& txt, _In_ TextField pos); + void setImagePath(_In_ const std::wstring& imgPath); + void setAudioPath(_In_ const std::wstring& audioPath); + void setAttributionText(_In_ const std::wstring & attributionText); + void addAction(_In_ const std::wstring& label); + void setAudioOption(_In_ WinToastTemplate::AudioOption audioOption); + void setDuration(_In_ Duration duration); + void setExpiration(_In_ INT64 millisecondsFromNow); + std::size_t textFieldsCount() const; + std::size_t actionsCount() const; + bool hasImage() const; + const std::vector& textFields() const; + const std::wstring& textField(_In_ TextField pos) const; + const std::wstring& actionLabel(_In_ int pos) const; + const std::wstring& imagePath() const; + const std::wstring& audioPath() const; + const std::wstring& attributionText() const; + INT64 expiration() const; + WinToastTemplateType type() const; + WinToastTemplate::AudioOption audioOption() const; + Duration duration() const; private: std::vector _textFields; - std::wstring _imagePath; - std::wstring _audioPath; std::vector _actions; - INT64 _expiration; - WinToastTemplateType _type; - WinToastTemplate::AudioOption _audioOption = WinToastTemplate::AudioOption::Default; - std::wstring _attributionText; + std::wstring _imagePath = L""; + std::wstring _audioPath = L""; + std::wstring _attributionText = L""; + INT64 _expiration = 0; + AudioOption _audioOption = WinToastTemplate::AudioOption::Default; + WinToastTemplateType _type = WinToastTemplateType::Text01; + Duration _duration = Duration::System; }; class WinToast { public: - WinToast(void); - virtual ~WinToast(); - static WinToast instance(); - static bool isCompatible(); - static bool supportModernFeatures(); - static std::wstring configureAUMI(_In_ const std::wstring& companyName, - _In_ const std::wstring& productName, - _In_ const std::wstring& subProduct = std::wstring(), - _In_ const std::wstring& versionInformation = std::wstring() - ); - virtual bool initialize(); - virtual bool isInitialized() const { return _isInitialized; } - virtual INT64 showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler); - virtual bool hideToast(_In_ INT64 id); - virtual void clear(); - inline std::wstring appName() const { return _appName; } - inline std::wstring appUserModelId() const { return _aumi; } - void setAppUserModelId(_In_ const std::wstring& appName); - void setAppName(_In_ const std::wstring& appName); + enum WinToastError { + NoError = 0, + NotInitialized, + SystemNotSupported, + ShellLinkNotCreated, + InvalidAppUserModelID, + InvalidParameters, + InvalidHandler, + NotDisplayed, + UnknownError + }; enum ShortcutResult { SHORTCUT_UNCHANGED = 0, @@ -123,7 +123,29 @@ namespace WinToastLib { SHORTCUT_COM_INIT_FAILURE = -3, SHORTCUT_CREATE_FAILED = -4 }; + + WinToast(void); + virtual ~WinToast(); + static WinToast* instance(); + static bool isCompatible(); + static bool isSupportingModernFeatures(); + static std::wstring configureAUMI(_In_ const std::wstring& companyName, + _In_ const std::wstring& productName, + _In_ const std::wstring& subProduct = std::wstring(), + _In_ const std::wstring& versionInformation = std::wstring() + ); + virtual bool initialize(_Out_ WinToastError* error = nullptr); + virtual bool isInitialized() const; + virtual bool hideToast(_In_ INT64 id); + virtual INT64 showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler, _Out_ WinToastError* error = nullptr); + virtual void clear(); virtual enum ShortcutResult createShortcut(); + + const std::wstring& appName() const; + const std::wstring& appUserModelId() const; + void setAppUserModelId(_In_ const std::wstring& appName); + void setAppName(_In_ const std::wstring& appName); + protected: bool _isInitialized; bool _hasCoInitialized; @@ -131,14 +153,16 @@ namespace WinToastLib { std::wstring _aumi; std::map> _buffer; - HRESULT validateShellLinkHelper(_Out_ bool& wasChanged); - HRESULT createShellLinkHelper(); - HRESULT setImageFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& path); - HRESULT setAudioFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& path, _In_opt_ WinToastTemplate::AudioOption option = WinToastTemplate::AudioOption::Default); - HRESULT setTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& text, _In_ int pos); - HRESULT setAttributionTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& text); - HRESULT addActionHelper(_In_ IXmlDocument xml, _In_ const std::wstring& action, _In_ const std::wstring& arguments); + HRESULT validateShellLinkHelper(_Out_ bool& wasChanged); + HRESULT createShellLinkHelper(); + HRESULT setImageFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& path); + HRESULT setAudioFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& path, _In_opt_ WinToastTemplate::AudioOption option = WinToastTemplate::AudioOption::Default); + HRESULT setTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& text, _In_ int pos); + HRESULT setAttributionTextFieldHelper(_In_ IXmlDocument xml, _In_ const std::wstring& text); + HRESULT addActionHelper(_In_ IXmlDocument xml, _In_ const std::wstring& action, _In_ const std::wstring& arguments); + HRESULT addDurationHelper(_In_ IXmlDocument xml, _In_ const std::wstring& duration); ComPtr notifier(_In_ bool succeded) const; + void setError(_Out_ WinToastError* error, _In_ WinToastError value); }; } #endif // WINTOASTLIB_H diff --git a/tests/test_template.py b/tests/test_template.py index c11bdfa..dc606cc 100644 --- a/tests/test_template.py +++ b/tests/test_template.py @@ -152,3 +152,56 @@ def test_getImage_ProperParams(self): path = os.path.abspath("./tests/files/image.png") template.setImage(path) self.assertEqual(template.getImage(), path) + + ### Duration + def test_setDuration_InvalidParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(TypeError, lambda: template.setDuration(-1)) + + def test_setDuration_InvalidParams2(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(TypeError, lambda: template.setDuration("error")) + + def test_setDuration_EmptyParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(TypeError, lambda: template.setDuration()) + + def test_setDuration_ProperParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertTrue(template.setDuration(zroya.TemplateDuration.Long)) + + def test_getDuration(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + template.setDuration(zroya.TemplateDuration.Long) + self.assertEqual(template.getDuration(), zroya.TemplateDuration.Long) + + ### Actions + def test_addAction_InvalidParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(TypeError, lambda: template.addAction(-1)) + + def test_addAction_EmptyParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(TypeError, lambda: template.addAction()) + + def test_addAction_ProperParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertEquals(template.addAction("First"), 0) + + def test_countAction_ProperParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + template.addAction("First") + self.assertEquals(template.countActions(), 1) + + def test_getAction_InvalidParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(IndexError, lambda: template.getAction(-1)) + + def test_getAction_EmptyParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + self.assertRaises(TypeError, lambda: template.getAction()) + + def test_getAction_ProperParams(self): + template = zroya.Template(zroya.TemplateType.ImageAndText1) + template.addAction("First") + self.assertEquals(template.getAction(0), "First") diff --git a/zroya/template_enums.py b/zroya/template_enums.py index 847f55d..0e25246 100644 --- a/zroya/template_enums.py +++ b/zroya/template_enums.py @@ -293,3 +293,27 @@ class TemplateType(IntEnum): One string of bold text on the first line, one string of regular text on the second line, one string of regular text on the third line. """ + + +class TemplateDuration(Enum): + """ + All allowed values for :py:meth:`zroya.Template.setDuration` and return values of + :py:meth:`zroya.Template.getDuration`. + + Duration sets the time notification is shown before it is moved to Action Center. + """ + + System = "system" + """ + Default duration based on system configuration. + """ + + Long = "long" + """ + Long duration. + """ + + Short = "short" + """ + Shord duration + """