Changes between Version 9 and Version 10 of libroar/plugins


Ignore:
Timestamp:
01/15/13 15:38:33 (8 years ago)
Author:
ph3-der-loewe
Comment:

updated AppSched? infos

Legend:

Unmodified
Added
Removed
Modified
  • libroar/plugins

    v9 v10  
    2626AppSched works by registering callbacks for special events. The following events are defined: 
    2727 
    28 ||= Event =||= Description =|| 
    29 ||INIT     ||This is called when the application wants to start the plugin. Normally you run code to open IO or build data structures here. || 
    30 ||FREE     ||This is called when the plugin is no longer used (on unload). You normally close all your IO and free memory you allocated here. || 
    31 ||UPDATE   ||This is called when you should do a main loop iteration. You can check your IO here and do your work. This function must not block. This is normally called once per main loop cycle of the host application. || 
    32 ||TICK     ||This is a an asynchronous event. Some applications use it when doing some longer work. It can be used to sync your IO like answer re-draw requests from the X server. You must not block in this function. || 
    33 ||WAIT     ||This is to ask the plugin to block and wait for new work to be done. This is normally used to wait for new IO events such as data from clients or X11 events. This can block for a long time. UPDATE is called soon after this returned so you do not need to call it from here. || 
     28||= Event =||= Min. Version =||= Description =|| 
     29||INIT     ||old ||This is called when the application wants to start the plugin. Normally you run code to open IO or build data structures here. || 
     30||FREE     ||old ||This is called when the plugin is no longer used (on unload). You normally close all your IO and free memory you allocated here. || 
     31||UPDATE   ||old ||This is called when you should do a main loop iteration. You can check your IO here and do your work. This function must not block. This is normally called once per main loop cycle of the host application. || 
     32||TICK     ||old ||This is a an asynchronous event. Some applications use it when doing some longer work. It can be used to sync your IO like answer re-draw requests from the X server. You must not block in this function. || 
     33||WAIT     ||old ||This is to ask the plugin to block and wait for new work to be done. This is normally used to wait for new IO events such as data from clients or X11 events. This can block for a long time. UPDATE is called soon after this returned so you do not need to call it from here. || 
     34||ABOUT    ||1.0beta9-pr0 ||This event is used to show an about dialog. If not provided by the plugin this is automatically provided by the plugin API. Note: No callback can be set for this before libroar3. || 
     35||HELP     ||1.0beta9-pr0 ||This event is used to show a help dialog. If not provided by the plugin this is automatically provided by the plugin API. Note: No callback can be set for this before libroar3. || 
     36||PREFERENCES ||1.0beta9-pr0 ||This event is used to show an options dialog. This is currently not supported. || 
    3437 
    3538Every AppSched using application (every should in fact!) will send INIT, FREE and UPDATE. The usage of TICK and WAIT is optional by the application.