raoul/openlp
1
0
Fork 0
forked from openlp/openlp
Code Issues Pull Requests Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Tim Bentley 2009-07-11 06:20:33 +01:00
parent ccb85f8f4b
commit d02f6da213
6 changed files with 27 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
documentation/build/doctrees/core/index.doctree
View File

Binary file not shown.

BIN
documentation/build/doctrees/environment.pickle
View File

Binary file not shown.

20
documentation/build/html/core/index.html
View File

@ -235,9 +235,25 @@ Place, Suite 330, Boston, MA 02111-1307 USA</p>
<dl class="class">
<dt id="openlp.core.lib.eventmanager.EventManager">
<!--[openlp.core.lib.eventmanager.EventManager]-->class <tt class="descname">EventManager</tt><a class="headerlink" href="#openlp.core.lib.eventmanager.EventManager" title="Permalink to this definition"></a></dt>
<dd>A mechanism to send events to all registered endpoints
<dd><p>A mechanism to send events to all registered endpoints
the endpoints are registered and listen with a handle_event method
the endpoint will decide whether to do somthing with the event or ignore it</dd></dl>
the endpoint will decide whether to do somthing with the event or ignore it</p>
<dl class="method">
<dt id="openlp.core.lib.eventmanager.EventManager.post_event">
<!--[openlp.core.lib.eventmanager.EventManager.post_event]--><tt class="descname">post_event</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#openlp.core.lib.eventmanager.EventManager.post_event" title="Permalink to this definition"></a></dt>
<dd><p>Called by any part of the system which wants send events to the plugins</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">event</span></tt></dt>
<dd>The event type to be triggered</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="openlp.core.lib.eventmanager.EventManager.register">
<!--[openlp.core.lib.eventmanager.EventManager.register]--><tt class="descname">register</tt><big>(</big><em>plugin</em><big>)</big><a class="headerlink" href="#openlp.core.lib.eventmanager.EventManager.register" title="Permalink to this definition"></a></dt>
<dd>Called by plugings who wish to receive event notifications</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-openlp.core.lib.eventreceiver">

6
documentation/build/html/genindex.html
View File

@ -127,7 +127,8 @@
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="migration/index.html#openlp.migration.migratesongs.BaseModel.populate">populate (BaseModel attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="migration/index.html#openlp.migration.migratesongs.BaseModel.populate">populate (BaseModel attribute)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventmanager.EventManager.post_event">post_event() (EventManager method)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="R">R</h2>
@ -135,7 +136,8 @@
<dl>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver.receive">receive (Receiver attribute)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver">Receiver (class in openlp.core.lib.eventreceiver)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/index.html#openlp.core.lib.eventreceiver.Receiver">Receiver (class in openlp.core.lib.eventreceiver)</a></dt>
<dt><a href="core/index.html#openlp.core.lib.eventmanager.EventManager.register">register() (EventManager method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/index.html#openlp.core.lib.ServiceItem.render">render() (ServiceItem method)</a></dt>
</dl></td></tr></table>

6
documentation/build/html/objects.inv
View File

@ -12,15 +12,15 @@ openlp.plugins.images mod plugins/index.html
openlp.plugins.songs mod plugins/index.html
openlp.core mod core/index.html
openlp.migration.migratesongs mod migration/index.html
openlp.core.theme mod core/index.html
openlp.plugins mod plugins/index.html
openlp.plugins.presentations mod plugins/index.html
openlp.plugins.media mod plugins/index.html
openlp.plugins.bibles mod plugins/index.html
openlp.core.lib.baselistwithdnd mod core/index.html
openlp.core.lib.event mod core/index.html
openlp.plugins.custom mod plugins/index.html
openlp mod openlp.html
openlp.core.theme mod core/index.html
openlp.plugins.presentations mod plugins/index.html
openlp.core.lib.ServiceItem.get_oos_repr method core/index.html
openlp.core.lib.ServiceItem.render method core/index.html
openlp.core.lib.eventreceiver.Receiver class core/index.html
@ -29,6 +29,7 @@ openlp.core.lib.baselistwithdnd.BaseListWithDnD class core/index.html
openlp.core.lib.event.Event class core/index.html
openlp.migration.migratesongs.BaseModel class migration/index.html
openlp.core.lib.eventreceiver.Receiver.send_message attribute core/index.html
openlp.core.lib.eventmanager.EventManager.register method core/index.html
openlp.core.lib.eventmanager.EventManager class core/index.html
openlp.migration.migratesongs.BaseModel.populate attribute migration/index.html
openlp.core.lib.eventreceiver.Receiver.receive attribute core/index.html
@ -45,3 +46,4 @@ openlp.migration.migratesongs.TAuthor class migration/index.html
openlp.core.lib.ServiceItem.set_from_oos method core/index.html
openlp.core.lib.ServiceItem class core/index.html
openlp.core.lib.contextMenuAction function core/index.html
openlp.core.lib.eventmanager.EventManager.post_event method core/index.html

2
documentation/build/html/searchindex.js
View File

@ -1 +1 @@
Search.setIndex({desctypes:{"0":"method","1":"class","2":"attribute","3":"function"},terms:{recipi:4,all:4,help:4,just:4,migrateb:[0,1],text:4,move:4,lyric:[1,2,3,4],messageid:4,mousemoveev:4,openlp:[0,1,2,3,4],disk:4,slot:4,decid:4,locat:4,guerreri:4,copyright:[1,2,3,4],menu:4,frame_titl:4,send:4,should:[0,1,2,3,4],whether:4,theme:[0,4],program:[1,2,3,4],snyman:[1,2,3,4],under:[1,2,3,4],thompson:[1,2,3,4],save:4,hope:[1,2,3,4],build:4,merchant:[1,2,3,4],tsongauthor:1,sourc:[1,2,3,4],"return":[1,4],around:4,song:[0,2],none:4,util:4,add_from_command:4,mechan:4,command:4,span:[1,2,3,4],requir:4,eventtyp:4,term:[1,2,3,4],document:0,name:4,somth:4,docutil:[1,2,3,4],signal:4,drop:4,method:4,item:4,slide:4,have:[1,2,3,4],serviceitem:4,scott:4,architectur:4,manag:4,pleas:4,servicemanag:4,impli:[1,2,3,4],set:1,frame:4,some:4,direct:0,across:4,redistribut:[1,2,3,4],"static":4,connect:4,bentlei:[1,2,3,4],pass:4,extract:4,event:4,contextmenuact:4,hostplugin:4,even:[1,2,3,4],index:0,what:4,publish:[1,2,3,4],your:0,content:0,"public":[1,2,3,4],version:[1,2,3,4],adapt:0,jonathan:4,tingaard:4,eventreceiv:4,migratesong:[0,1],core:[0,4],privat:4,bibl:[0,2],parent:4,event_typ:4,migrat:[0,1],screen:4,martin:[1,2,3,4],onli:4,free:[1,2,3,4],like:0,base:[1,4],here:4,put:4,compositor:4,along:[1,2,3,4],templ:[1,2,3,4],modifi:[1,2,3,4],popul:1,raoul:[1,2,3,4],search:0,actual:4,fit:[1,2,3,4],plugin:[0,2,4],baselistwithdnd:4,drag:4,carsten:[2,4],instanc:[1,4],place:[1,2,3,4],descript:4,context:4,basemodel:1,gener:[1,2,3,4],fri:0,softwar:[1,2,3,4],via:4,directli:4,modul:[0,1,2,3,4],within:4,foundat:[1,2,3,4],submodul:[0,1,4],system:4,warranti:[1,2,3,4],model:1,messag:4,path:4,qobject:4,open:[1,2,3,4],payload:4,select:4,quickstart:0,differ:4,from:4,usa:[1,2,3,4],interact:4,regist:4,add:4,least:0,custom:[0,2],addicon:4,call:4,handle_ev:4,suit:[1,2,3,4],master:0,set_from_oo:4,type:4,tell:4,store:4,more:[1,2,3,4],"function":1,wrapper:4,imag:[0,2,4],copi:[1,2,3,4],jul:0,provid:[1,4],part:4,particular:[1,2,3,4],present:[0,2],send_messag:4,endpoint:4,gnu:[1,2,3,4],"default":4,qtcore:4,servic:4,displai:[0,1,4],project:[1,2,3,4],can:[0,1,2,3,4],add_from_imag:4,purpos:[1,2,3,4],root:0,get_oos_repr:4,care:4,control:4,listen:4,encapsul:4,creat:[0,1],boston:[1,2,3,4],toctre:0,ani:[1,2,3,4],indic:0,repres:4,raw:4,add_from_text:4,file:[0,4],tabl:0,tauthor:1,string:4,pre:[1,2,3,4],lib:[0,4],author:1,receiv:[1,2,3,4],titl:4,when:4,detail:[1,2,3,4],write:[1,2,3,4],tim:[1,2,3,4],raw_slid:4,take:4,which:4,icon:4,you:[0,1,2,3,4],inc:[1,2,3,4],corwin:4,complet:0,tinggaard:2,resourc:4,distribut:[1,2,3,4],see:[1,2,3,4],liter:[1,2,3,4],openlprepaint:4,org:4,licens:[1,2,3,4],get_receiv:4,action:4,render:4,thi:[0,1,2,3,4],contain:0,data:4,"class":[1,2,3,4],welcom:0,"short":4,sphinx:0,qicon:4,directori:4,eventmanag:4,page:0,request:4,object:1,doe:4,portion:[1,2,3,4],without:[1,2,3,4],ignor:4,allow:4,media:[0,2],tsong:1,migratefil:[0,1],usual:4},titles:["Welcome to OpenLP&#8217;s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">migration</span></tt> Module","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">plugins</span></tt> Module","<tt class=\"docutils literal docutils literal docutils literal\"><span class=\"pre\">openlp</span></tt> Module","<tt class=\"docutils literal\"><span class=\"pre\">core</span></tt> Module"],modules:{"openlp.core.lib.eventreceiver":4,"openlp.migration.display":1,"openlp.core.lib":4,"openlp.migration.migratefiles":1,"openlp.core.lib.eventmanager":4,"openlp.migration.migratebibles":1,"openlp.migration":1,"openlp.plugins.images":2,"openlp.plugins.songs":2,"openlp.core":4,"openlp.migration.migratesongs":1,"openlp.core.theme":4,"openlp.plugins":2,"openlp.plugins.media":2,"openlp.plugins.bibles":2,"openlp.core.lib.baselistwithdnd":4,"openlp.core.lib.event":4,"openlp.plugins.custom":2,openlp:3,"openlp.plugins.presentations":2},descrefs:{"openlp.core.lib.eventreceiver":{EventReceiver:[4,1],Receiver:[4,1]},"openlp.core.lib":{contextMenuAction:[4,3],ServiceItem:[4,1]},"openlp.core.lib.eventmanager":{EventManager:[4,1]},"openlp.core.lib.ServiceItem":{set_from_oos:[4,0],render:[4,0],addIcon:[4,0],add_from_command:[4,0],add_from_text:[4,0],add_from_image:[4,0],get_oos_repr:[4,0]},"openlp.core.lib.eventreceiver.Receiver":{get_receiver:[4,2],receive:[4,2],send_message:[4,2]},"openlp.migration.migratesongs":{TSongAuthor:[1,1],TSong:[1,1],TAuthor:[1,1],BaseModel:[1,1]},"openlp.core.lib.baselistwithdnd.BaseListWithDnD":{mouseMoveEvent:[4,0]},"openlp.core.lib.baselistwithdnd":{BaseListWithDnD:[4,1]},"openlp.core.lib.event":{EventType:[4,1],Event:[4,1]},"openlp.migration.migratesongs.BaseModel":{populate:[1,2]}},filenames:["index","migration/index","plugins/index","openlp","core/index"]})
Search.setIndex({desctypes:{"0":"method","1":"class","2":"attribute","3":"function"},terms:{recipi:4,all:4,help:4,just:4,migrateb:[0,1],text:4,move:4,lyric:[1,2,3,4],file:[0,4],messageid:4,mousemoveev:4,openlp:[0,1,2,3,4],disk:4,qtcore:4,request:4,slot:4,decid:4,locat:4,guerreri:4,copyright:[1,2,3,4],menu:4,frame_titl:4,send:4,should:[0,1,2,3,4],whether:4,theme:[0,4],program:[1,2,3,4],titl:4,snyman:[1,2,3,4],under:[1,2,3,4],thompson:[1,2,3,4],save:4,get_receiv:4,hope:[1,2,3,4],take:4,merchant:[1,2,3,4],tsongauthor:1,sourc:[1,2,3,4],"return":[1,4],around:4,song:[0,2],send_messag:4,util:4,add_from_command:4,endpoint:4,mechan:4,requir:4,eventtyp:4,term:[1,2,3,4],name:4,somth:4,docutil:[1,2,3,4],signal:4,drop:4,method:4,item:4,slide:4,serviceitem:4,scott:4,complet:0,manag:4,pleas:4,impli:[1,2,3,4],set:1,frame:4,interact:4,some:4,direct:0,across:4,redistribut:[1,2,3,4],"static":4,connect:4,bentlei:[1,2,3,4],pass:4,extract:4,event:4,contextmenuact:4,distribut:[1,2,3,4],even:[1,2,3,4],index:0,what:4,publish:[1,2,3,4],payload:4,content:0,"public":[1,2,3,4],tinggaard:2,version:[1,2,3,4],adapt:0,tingaard:4,eventreceiv:4,migratesong:[0,1],core:[0,4],privat:4,bibl:[0,2],parent:4,event_typ:4,migrat:[0,1],screen:4,martin:[1,2,3,4],onli:4,free:[1,2,3,4],like:0,control:4,base:[1,4],here:4,put:4,compositor:4,along:[1,2,3,4],templ:[1,2,3,4],modifi:[1,2,3,4],popul:1,raoul:[1,2,3,4],search:0,actual:4,fit:[1,2,3,4],plugin:[0,2,4],root:0,drag:4,carsten:[2,4],instanc:[1,4],place:[1,2,3,4],context:4,basemodel:1,gener:[1,2,3,4],fri:0,softwar:[1,2,3,4],via:4,directli:4,modul:[0,1,2,3,4],within:4,foundat:[1,2,3,4],submodul:[0,1,4],warranti:[1,2,3,4],least:0,path:4,custom:[0,2],open:[1,2,3,4],your:0,select:4,quickstart:0,differ:4,span:[1,2,3,4],usa:[1,2,3,4],licens:[1,2,3,4],regist:4,system:4,messag:4,qobject:4,addicon:4,trigger:4,call:4,handle_ev:4,suit:[1,2,3,4],master:0,set_from_oo:4,type:4,tell:4,store:4,more:[1,2,3,4],"function":1,from:4,wrapper:4,imag:[0,2,4],copi:[1,2,3,4],jul:0,provid:[1,4],part:4,particular:[1,2,3,4],present:[0,2],tsong:1,none:4,jonathan:4,gnu:[1,2,3,4],"default":4,wish:4,servic:4,displai:[0,1,4],project:[1,2,3,4],directori:4,can:[0,1,2,3,4],add_from_imag:4,allow:4,purpos:[1,2,3,4],baselistwithdnd:4,get_oos_repr:4,care:4,pre:[1,2,3,4],listen:4,have:[1,2,3,4],creat:[0,1],boston:[1,2,3,4],toctre:0,ani:[1,2,3,4],indic:0,repres:4,raw:4,add_from_text:4,want:4,tabl:0,tauthor:1,string:4,inc:[1,2,3,4],welcom:0,lib:[0,4],author:1,receiv:[1,2,3,4],media:[0,2],when:4,detail:[1,2,3,4],write:[1,2,3,4],tim:[1,2,3,4],raw_slid:4,build:4,which:4,post_ev:4,ignor:4,you:[0,1,2,3,4],document:0,corwin:4,architectur:4,notif:4,resourc:4,hostplugin:4,see:[1,2,3,4],liter:[1,2,3,4],openlprepaint:4,org:4,who:4,pluge:4,servicemanag:4,action:4,render:4,contain:0,data:4,"class":[1,2,3,4],icon:4,"short":4,sphinx:0,qicon:4,encapsul:4,eventmanag:4,page:0,descript:4,object:1,doe:4,portion:[1,2,3,4],without:[1,2,3,4],command:4,thi:[0,1,2,3,4],add:4,model:1,migratefil:[0,1],usual:4},titles:["Welcome to OpenLP&#8217;s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">migration</span></tt> Module","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">plugins</span></tt> Module","<tt class=\"docutils literal docutils literal docutils literal\"><span class=\"pre\">openlp</span></tt> Module","<tt class=\"docutils literal\"><span class=\"pre\">core</span></tt> Module"],modules:{"openlp.core.lib.eventreceiver":4,"openlp.migration.display":1,"openlp.core.lib":4,"openlp.migration.migratefiles":1,"openlp.core.lib.eventmanager":4,"openlp.migration.migratebibles":1,"openlp.migration":1,"openlp.plugins.images":2,"openlp.plugins.songs":2,"openlp.core":4,"openlp.migration.migratesongs":1,"openlp.plugins":2,"openlp.plugins.presentations":2,"openlp.plugins.media":2,"openlp.plugins.bibles":2,"openlp.core.lib.baselistwithdnd":4,"openlp.core.lib.event":4,"openlp.plugins.custom":2,openlp:3,"openlp.core.theme":4},descrefs:{"openlp.core.lib.eventreceiver":{EventReceiver:[4,1],Receiver:[4,1]},"openlp.core.lib.eventmanager.EventManager":{register:[4,0],post_event:[4,0]},"openlp.core.lib.eventmanager":{EventManager:[4,1]},"openlp.core.lib.ServiceItem":{set_from_oos:[4,0],render:[4,0],addIcon:[4,0],add_from_command:[4,0],add_from_text:[4,0],add_from_image:[4,0],get_oos_repr:[4,0]},"openlp.core.lib.eventreceiver.Receiver":{get_receiver:[4,2],receive:[4,2],send_message:[4,2]},"openlp.migration.migratesongs":{TSongAuthor:[1,1],TSong:[1,1],TAuthor:[1,1],BaseModel:[1,1]},"openlp.core.lib.baselistwithdnd.BaseListWithDnD":{mouseMoveEvent:[4,0]},"openlp.core.lib.baselistwithdnd":{BaseListWithDnD:[4,1]},"openlp.core.lib.event":{EventType:[4,1],Event:[4,1]},"openlp.migration.migratesongs.BaseModel":{populate:[1,2]},"openlp.core.lib":{contextMenuAction:[4,3],ServiceItem:[4,1]}},filenames:["index","migration/index","plugins/index","openlp","core/index"]})