krita.decorators Namespace Reference

Functions
	_callAll (plugin, functions, *args, **kwargs)
	_registerCallback (plugin, event, func)
	_simpleEventListener (func)
	init (func)
	pykritaEventHandler (event)
	unload (func)

Detailed Description

Decorators used in plugins

Function Documentation

_callAll()

krita.decorators._callAll ( plugin, functions, * args, ** kwargs )

protected

Definition at line 37 of file decorators.py.

def _callAll(plugin, functions, *args, **kwargs):
    if plugin in functions:
        for f in functions[plugin]:
            try:
                f(*args, **kwargs)
            except:
                traceback.print_exc()
                sys.stderr.write('\n')
                # TODO Return smth to a caller, so in case of
                # failed initialization it may report smth to the
                # C++ level and latter can show an error to the user...
                continue
 
 

_registerCallback()

krita.decorators._registerCallback ( plugin, event, func )

protected

Definition at line 60 of file decorators.py.

def _registerCallback(plugin, event, func):
    if plugin not in event.functions:
        event.functions[plugin] = set()
 
    event.functions[plugin].add(func)
    return func
 
 
@_simpleEventListener

_simpleEventListener()

krita.decorators._simpleEventListener ( func )

protected

Definition at line 51 of file decorators.py.

def _simpleEventListener(func):
    # automates the most common decorator pattern: calling a bunch
    # of functions when an event has occurred
    func.functions = dict()
    func.fire = functools.partial(_callAll, functions=func.functions)
    func.clear = func.functions.clear
    return func
 
 

init()

krita.decorators.init

(

func

)

 The function will be called when particular plugin has loaded
    and the configuration has been initiated

Definition at line 69 of file decorators.py.

def init(func):
    ''' The function will be called when particular plugin has loaded
        and the configuration has been initiated
    '''
    plugin = sys._getframe(1).f_globals['__name__']
    qDebug('@init: {}/{}'.format(plugin, func.__name__))
    return _registerCallback(plugin, init, func)
 
 
@_simpleEventListener

References krita.decorators._registerCallback().

pykritaEventHandler()

krita.decorators.pykritaEventHandler

(

event

)

Definition at line 30 of file decorators.py.

def pykritaEventHandler(event):
    def _decorator(func):
        setattr(pykrita, event, func)
        del func
    return _decorator
 
 

unload()

krita.decorators.unload

(

func

)

 The function will be called when particular plugin is being
    unloaded from memory. Clean up any widgets that you have added
    to the interface (toolviews etc).

    ATTENTION Be really careful trying to access any window, view
        or document from the @unload handler: in case of application
        quit everything is dead already!

Definition at line 79 of file decorators.py.

def unload(func):
    ''' The function will be called when particular plugin is being
        unloaded from memory. Clean up any widgets that you have added
        to the interface (toolviews etc).
 
        ATTENTION Be really careful trying to access any window, view
            or document from the @unload handler: in case of application
            quit everything is dead already!
    '''
    plugin = sys._getframe(1).f_globals['__name__']
    qDebug('@unload: {}/{}'.format(plugin, func.__name__))
 
    def _module_cleaner():
        qDebug('@unload/cleaner: {}/{}'.format(plugin, func.__name__))
        if plugin in init.functions:
            qDebug('@unload/init-cleaner: {}/{}'.format(plugin, func.__name__))
            del init.functions[plugin]
 
        func()
 
    return _registerCallback(plugin, unload, _module_cleaner)

References krita.decorators._registerCallback().