mojo.subscriber

getRegisteredSubscriberEvents()

A dictionary of all registered subscriber events.

registerSubscriberEvent(subscriberEventName, methodName, lowLevelEventNames, dispatcher, observeAllInstances=False, eventEligibilityFunction=None, eventInfoExtractionFunction=None, delay=None, documentation='', debug=False)

subscriberEventName : The subscriber event name.
methodName : The method name to be implemented in the Subscriber subclass.
lowLevelEventNames : A list of low-level event names that will be posted by dispatcher. This may also be a string if there is only one low level event name.
dispatcher : The dispatcher that low level events will be posted from. "roboFont" or "defcon.*" where * is a defcon class name.
observeAllInstances : If True lowLevelEventNames will be observed for all instances. This only applies to defcon defcon.Font, defcon.LayerSet and defcon.Layer objects and it is accomplished by sending None as the observable with the lowLevelEventNames to the low level defcon dispatcher. This should be used sparingly as it can cause a significant number of calls to Subscriber instances that implement methodName.
eventInfoExtractionFunction : A function for extracting information from the coalesced low-level events. Optional.
eventEligibilityFunction : A function for determining if a low-level event should be passed to a subscriber. Optional.
delay : A number defining the default delay for the event. Optional. If a value is not given, the default value for the given dispatcher will be used.
documentation : A string defining documentation for the event. Optional.
debug : A boolean to be used when developing a subscriber event. Optional. False by default

Developers may use this function to add to the built-in events. This function should always be called with key-word arguments instead of unnamed arguments. The argument order may change and new arguments may be added.

from mojo.subscriber import Subscriber, registerRoboFontSubscriber, registerSubscriberEvent

class SimpleSubscriberDemo(Subscriber):

    def myCustomSubscriberMethod(self, info):
        print("myCustomSubscriberMethod", info)


registerSubscriberEvent(
    subscriberEventName="com.robofont.demo.subscriberEvent",
    methodName="myCustomSubscriberMethod",
    lowLevelEventNames=["com.robofont.demo.mojoEvent"],
    dispatcher="roboFont",
    delay=1,
    documentation="This is my custom subscriber method."
)

registerRoboFontSubscriber(SimpleSubscriberDemo)


# ------------------
# SOME TIME LATER...
# ------------------

import random
from mojo.events import postEvent

postEvent("com.robofont.demo.mojoEvent", information="data", number=random.choice((-1, 1)))

eventInfoExtractionFunction

If a low-level event has special data that needs to be extracted from the low-level data and translated into the high-level data, define an eventInfoExtractionFunction like this:

def simpleSubscriberEventInfoExtractor(subscriber, info):
    info["information"] = []
    for lowLevelEvent in info["lowLevelEvents"]:
        info["information"] = lowLevelEvent["information"]

If this is not defined, the raw low-level data will be passed as the high-level data.

eventEligibilityFunction

If a high-level event should be triggered only when certain conditions are met, define an eventEligibilityFunction like this:

def simpleSubscriberEventEligibility(subscriber, event):
    number = event["number"]
    if number == 1:
        return True
    return False

If this is not defined, the eligibility for a high-level event is always True.

registerRoboFontSubscriber(subscriberClass)

Register a Subscriber subclass that will be instantiated when RoboFont is started. This object will remain alive until RoboFont is quit.