diff --git a/.doctrees/dbus.doctree b/.doctrees/dbus.doctree index 3880d5e8..99913ec6 100644 Binary files a/.doctrees/dbus.doctree and b/.doctrees/dbus.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 6389ec87..b42629b8 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/_sources/dbus.rst.txt b/_sources/dbus.rst.txt index a9616262..97ba66de 100644 --- a/_sources/dbus.rst.txt +++ b/_sources/dbus.rst.txt @@ -324,7 +324,7 @@ org.freedesktop.ratbag1.Profile ascending, the lowest report rate is the first item in the list. This list may be empty if the device does not support reading and/or - writing to resolutions. + writing the report rate. .. function:: SetActive() → () @@ -403,10 +403,6 @@ org.freedesktop.ratbag1.Resolution If the device does not have the disabled resolution capability, this property is always false. - This property is read-only, use the :func:`SetDisabled` - or :func:`SetEnabled` method to set a resolution as - disabled or enabled . - .. attribute:: Resolution :type: v @@ -504,7 +500,9 @@ org.freedesktop.ratbag1.Button +---------+---------+--------------------------------------+ | 2 | Special | Mapping to a special function | +---------+---------+--------------------------------------+ - | 3 | Macro | Mapping to a macro key sequence | + | 3 | Key | Mapping to a simple key action | + +---------+---------+--------------------------------------+ + | 4 | Macro | Mapping to a macro key sequence | +---------+---------+--------------------------------------+ | 1000 | Unknown | An unknown or unreadable mapping type| +---------+---------+--------------------------------------+ diff --git a/dbus.html b/dbus.html index 6d049a1d..fa9acfac 100644 --- a/dbus.html +++ b/dbus.html @@ -650,7 +650,7 @@ must be one of those listed in ReportRate property. This list is always sorted ascending, the lowest report rate is the first item in the list.

This list may be empty if the device does not support reading and/or -writing to resolutions.

+writing the report rate.

@@ -780,9 +780,6 @@ the default resolution.

True if this resolution is disabled, false otherwise. If the device does not have the disabled resolution capability, this property is always false.

-

This property is read-only, use the SetDisabled() -or SetEnabled() method to set a resolution as -disabled or enabled .

@@ -946,10 +943,14 @@ type is one of the following:

Mapping to a special function 3 +Key +Mapping to a simple key action + +4 Macro Mapping to a macro key sequence -1000 +1000 Unknown An unknown or unreadable mapping type diff --git a/searchindex.js b/searchindex.js index 127ee8ab..a2a445bd 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["dbus","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["dbus.rst","index.rst"],objects:{"":{APIVersion:[0,0,1,""],ActionTypes:[0,0,1,""],AngleSnapping:[0,0,1,""],Brightness:[0,0,1,""],Buttons:[0,0,1,""],Capabilities:[0,0,1,""],Color:[0,0,1,""],ColorDepth:[0,0,1,""],Commit:[0,1,1,""],Debounce:[0,0,1,""],Debounces:[0,0,1,""],Devices:[0,0,1,""],Disabled:[0,0,1,""],EffectDuration:[0,0,1,""],FirmwareVersion:[0,0,1,""],Index:[0,0,1,""],IsActive:[0,0,1,""],IsDefault:[0,0,1,""],IsDirty:[0,0,1,""],IsDisabled:[0,0,1,""],Leds:[0,0,1,""],Mapping:[0,0,1,""],Mode:[0,0,1,""],Model:[0,0,1,""],Modes:[0,0,1,""],Name:[0,0,1,""],Profiles:[0,0,1,""],ReportRate:[0,0,1,""],ReportRates:[0,0,1,""],Resolution:[0,0,1,""],Resolutions:[0,0,1,""],Resync:[0,1,1,""],SetActive:[0,1,1,""],SetDefault:[0,1,1,""]}},objnames:{"0":["py","attribute","Python attribute"],"1":["py","function","Python function"]},objtypes:{"0":"py:attribute","1":"py:function"},terms:{"0x40000000":0,"0x40000001":0,"0x40000002":0,"0x40000003":0,"0x40000004":0,"0x40000005":0,"0x40000006":0,"0x40000007":0,"0x40000008":0,"0x40000009":0,"0x4000000a":0,"0x4000000b":0,"0x4000000c":0,"0x4000000d":0,"0x4000000e":0,"0x4000000f":0,"0x40000010":0,"0x40000011":0,"0x40000012":0,"boolean":0,"default":0,"enum":0,"export":0,"function":1,"int":0,"new":0,"public":1,"switch":0,"true":0,"while":0,For:0,IDs:0,Ids:0,The:0,These:0,abcd:0,accordingli:0,actiontyp:0,activ:0,added:0,adding:0,after:0,all:0,allow:0,altern:0,alwai:0,angl:0,anglesnap:0,ani:0,anim:0,apivers:0,applic:0,arrai:0,ascend:0,assign:0,asynchron:0,avail:0,axes:0,axi:0,b10:0,backward:0,base:0,batteri:0,becom:0,befor:0,being:0,bind:0,bit:0,bluetooth:0,bool:0,both:0,breath:0,bright:0,bug:0,bus:0,button:1,call:0,caller:0,can:0,cannot:0,capabl:0,chang:[0,1],client:0,colon:0,color:0,colordepth:0,commit:0,compat:0,configur:0,consid:0,constant:0,construct:0,content:1,convers:0,correct:0,current:0,cycl:0,data:0,debounc:0,debug:0,decim:0,declar:0,defin:0,definit:0,denot:0,depth:0,describ:[0,1],descript:0,desir:0,detail:0,determin:0,devic:1,differ:0,digit:0,dirti:0,disabl:0,document:1,doe:0,doesn:0,doublelick:0,down:0,dpi:0,durat:0,each:0,easier:0,ef01:0,effect:0,effectdur:0,element:0,emit:0,empti:0,enabl:0,enough:0,entri:0,equal:0,error:0,event5:0,event:0,everyth:0,exactli:0,exampl:0,expect:0,extra:0,fail:0,fals:0,featur:0,firmwar:0,firmwarevers:0,first:0,flux:0,follow:0,format:0,forward:0,four:0,freedesktop:1,from:0,futur:0,gener:0,get:0,good:0,greatli:0,guarante:0,has:0,have:0,hex:0,ident:0,identifi:0,ignor:0,implement:0,inclus:0,increas:0,index:0,indic:0,intact:0,integ:0,interact:0,interfac:[0,1],intern:0,invalid:0,invok:0,isact:0,isdefault:0,isdirti:0,isdis:0,item:0,kei:0,keycod:0,known:0,least:0,leav:0,led:1,left:0,length:0,less:0,level:0,libratbag:0,lifetim:0,list:0,logic:0,lowercas:0,lowest:0,macro:0,mai:0,major:0,manag:1,manipul:0,manner:0,manufactur:0,map:0,mark:0,mask:0,method:0,might:0,millisecond:0,minor:0,mode:0,model:0,monochrom:0,must:0,mutabl:0,name:0,need:0,never:0,newer:0,none:0,normal:0,note:1,number:0,numer:0,object:0,occur:0,off:0,offset:0,older:0,onc:0,one:0,onli:0,option:0,org:1,other:0,otherwis:0,outsid:0,path:0,per:0,permit:0,physic:0,point:0,possibl:0,prepar:0,present:0,press:0,previous:0,process:0,product:0,profil:1,properti:0,propertychang:0,provid:0,pure:0,rang:0,ratbag1:1,ratbag:0,ratbag_resolution_cap:0,ratbagd:0,ratchet:0,rate:0,read:0,rebind:0,receiv:0,referenc:0,releas:0,reli:0,remov:0,report:0,reportr:0,reserv:0,resolut:1,resync:0,rgb:0,right:0,same:0,second:0,see:0,sensor:0,sent:0,separ:0,sequenc:0,set:0,setact:0,setdefault:0,setdis:0,seten:0,sever:0,signal:0,signific:0,singl:0,snap:0,sort:0,sourc:0,special:1,specif:0,specifi:0,stabl:0,start:0,state:0,step:0,still:0,stopgap:0,string:0,style:0,subject:[0,1],succe:0,suitabl:0,support:0,take:0,test:0,than:0,them:0,thi:[0,1],thing:0,those:0,three:0,through:0,time:0,triplet:0,tupl:0,uint:0,understand:0,uniqu:0,unknown:0,unless:0,unread:0,unsign:0,unspecifi:0,updat:0,upon:0,usb:0,use:0,used:0,user:0,uses:0,usual:0,uuu:0,valid:0,valu:0,vari:0,variant:0,variou:0,vendor:0,version:0,wheel:0,when:0,whenev:0,where:0,write:0,written:0,your:0,zero:0},titles:["DBus API","The libratbag DBus API"],titleterms:{"function":0,The:1,api:[0,1],button:0,dbu:[0,1],devic:0,flag:0,freedesktop:0,led:0,libratbag:1,manag:0,note:0,org:0,profil:0,ratbag1:0,resolut:0,special:0,type:0}}) \ No newline at end of file +Search.setIndex({docnames:["dbus","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["dbus.rst","index.rst"],objects:{"":{APIVersion:[0,0,1,""],ActionTypes:[0,0,1,""],AngleSnapping:[0,0,1,""],Brightness:[0,0,1,""],Buttons:[0,0,1,""],Capabilities:[0,0,1,""],Color:[0,0,1,""],ColorDepth:[0,0,1,""],Commit:[0,1,1,""],Debounce:[0,0,1,""],Debounces:[0,0,1,""],Devices:[0,0,1,""],Disabled:[0,0,1,""],EffectDuration:[0,0,1,""],FirmwareVersion:[0,0,1,""],Index:[0,0,1,""],IsActive:[0,0,1,""],IsDefault:[0,0,1,""],IsDirty:[0,0,1,""],IsDisabled:[0,0,1,""],Leds:[0,0,1,""],Mapping:[0,0,1,""],Mode:[0,0,1,""],Model:[0,0,1,""],Modes:[0,0,1,""],Name:[0,0,1,""],Profiles:[0,0,1,""],ReportRate:[0,0,1,""],ReportRates:[0,0,1,""],Resolution:[0,0,1,""],Resolutions:[0,0,1,""],Resync:[0,1,1,""],SetActive:[0,1,1,""],SetDefault:[0,1,1,""]}},objnames:{"0":["py","attribute","Python attribute"],"1":["py","function","Python function"]},objtypes:{"0":"py:attribute","1":"py:function"},terms:{"0x40000000":0,"0x40000001":0,"0x40000002":0,"0x40000003":0,"0x40000004":0,"0x40000005":0,"0x40000006":0,"0x40000007":0,"0x40000008":0,"0x40000009":0,"0x4000000a":0,"0x4000000b":0,"0x4000000c":0,"0x4000000d":0,"0x4000000e":0,"0x4000000f":0,"0x40000010":0,"0x40000011":0,"0x40000012":0,"boolean":0,"default":0,"enum":0,"export":0,"function":1,"int":0,"new":0,"public":1,"switch":0,"true":0,"while":0,For:0,IDs:0,Ids:0,The:0,These:0,abcd:0,accordingli:0,action:0,actiontyp:0,activ:0,added:0,adding:0,after:0,all:0,allow:0,altern:0,alwai:0,angl:0,anglesnap:0,ani:0,anim:0,apivers:0,applic:0,arrai:0,ascend:0,assign:0,asynchron:0,avail:0,axes:0,axi:0,b10:0,backward:0,base:0,batteri:0,becom:0,befor:0,being:0,bind:0,bit:0,bluetooth:0,bool:0,both:0,breath:0,bright:0,bug:0,bus:0,button:1,call:0,caller:0,can:0,cannot:0,capabl:0,chang:[0,1],client:0,colon:0,color:0,colordepth:0,commit:0,compat:0,configur:0,consid:0,constant:0,construct:0,content:1,convers:0,correct:0,current:0,cycl:0,data:0,debounc:0,debug:0,decim:0,declar:0,defin:0,definit:0,denot:0,depth:0,describ:[0,1],descript:0,desir:0,detail:0,determin:0,devic:1,differ:0,digit:0,dirti:0,disabl:0,document:1,doe:0,doesn:0,doublelick:0,down:0,dpi:0,durat:0,each:0,easier:0,ef01:0,effect:0,effectdur:0,element:0,emit:0,empti:0,enabl:0,enough:0,entri:0,equal:0,error:0,event5:0,event:0,everyth:0,exactli:0,exampl:0,expect:0,extra:0,fail:0,fals:0,featur:0,firmwar:0,firmwarevers:0,first:0,flux:0,follow:0,format:0,forward:0,four:0,freedesktop:1,from:0,futur:0,gener:0,get:0,good:0,greatli:0,guarante:0,has:0,have:0,hex:0,ident:0,identifi:0,ignor:0,implement:0,inclus:0,increas:0,index:0,indic:0,intact:0,integ:0,interact:0,interfac:[0,1],intern:0,invalid:0,invok:0,isact:0,isdefault:0,isdirti:0,isdis:0,item:0,kei:0,keycod:0,known:0,least:0,leav:0,led:1,left:0,length:0,less:0,level:0,libratbag:0,lifetim:0,list:0,logic:0,lowercas:0,lowest:0,macro:0,mai:0,major:0,manag:1,manipul:0,manner:0,manufactur:0,map:0,mark:0,mask:0,method:0,might:0,millisecond:0,minor:0,mode:0,model:0,monochrom:0,must:0,mutabl:0,name:0,need:0,never:0,newer:0,none:0,normal:0,note:1,number:0,numer:0,object:0,occur:0,off:0,offset:0,older:0,onc:0,one:0,onli:0,option:0,org:1,other:0,otherwis:0,outsid:0,path:0,per:0,permit:0,physic:0,point:0,possibl:0,prepar:0,present:0,press:0,previous:0,process:0,product:0,profil:1,properti:0,propertychang:0,provid:0,pure:0,rang:0,ratbag1:1,ratbag:0,ratbag_resolution_cap:0,ratbagd:0,ratchet:0,rate:0,read:0,rebind:0,receiv:0,referenc:0,releas:0,reli:0,remov:0,report:0,reportr:0,reserv:0,resolut:1,resync:0,rgb:0,right:0,same:0,second:0,see:0,sensor:0,sent:0,separ:0,sequenc:0,set:0,setact:0,setdefault:0,sever:0,signal:0,signific:0,simpl:0,singl:0,snap:0,sort:0,sourc:0,special:1,specif:0,specifi:0,stabl:0,start:0,state:0,step:0,still:0,stopgap:0,string:0,style:0,subject:[0,1],succe:0,suitabl:0,support:0,take:0,test:0,than:0,them:0,thi:[0,1],thing:0,those:0,three:0,through:0,time:0,triplet:0,tupl:0,uint:0,understand:0,uniqu:0,unknown:0,unless:0,unread:0,unsign:0,unspecifi:0,updat:0,upon:0,usb:0,use:0,used:0,user:0,uses:0,usual:0,uuu:0,valid:0,valu:0,vari:0,variant:0,variou:0,vendor:0,version:0,wheel:0,when:0,whenev:0,where:0,write:0,written:0,your:0,zero:0},titles:["DBus API","The libratbag DBus API"],titleterms:{"function":0,The:1,api:[0,1],button:0,dbu:[0,1],devic:0,flag:0,freedesktop:0,led:0,libratbag:1,manag:0,note:0,org:0,profil:0,ratbag1:0,resolut:0,special:0,type:0}}) \ No newline at end of file