Function connect_feat

lantz/ui/widgets.py:621–656

Connect a feature from a given driver to a widget. Calling this function also patches the widget is necessary. If applied two times with the same widget, it will connect to the target provided in the second call. This behaviour can be useful to change the connection target without r

(widget, target, feat_name=None, feat_key=MISSING)

def connect_feat(widget, target, feat_name=None, feat_key=MISSING):
    """Connect a feature from a given driver to a widget. Calling this
    function also patches the widget is necessary.

    If applied two times with the same widget, it will connect to the target
    provided in the second call. This behaviour can be useful to change the
    connection target without rebuilding the whole UI. Alternative, after
    connect has been called the first time, widget will have a property
    `lantz_target` that can be used to achieve the same thing.

    :param widget: widget instance.
    :param target: driver instance.
    :param feat_name: feature name. If None, connect using widget name.
    :param feat_key: For a DictFeat, this defines which key to show.
    """

    logger.debug('Connecting {} to {}, {}, {}'.format(widget, target, feat_name, feat_key))

    if not isinstance(target, Driver):
        raise TypeError('Connect target must be an instance of lantz.Driver, not {}'.format(target))

    if not feat_name:
        feat_name = widget.objectName()

    #: Reconnect
    if hasattr(widget, '_feat.name') and widget._feat.name == feat_name:
        widget.lantz_target = target
        return

    feat = target.feats[feat_name]

    WidgetMixin.wrap(widget)
    widget.bind_feat(feat)
    widget.feat_key = feat_key

    widget.lantz_target = target


def connect_driver(parent, target, *, prefix='', sep='__'):