lazy-widgets/dist/helpers/ComplementaryClickHelper.d.ts

Typescript retained mode GUI for the HTML canvas API

import { type BaseClickHelper } from './BaseClickHelper.js';
import { CompoundClickHelper } from './CompoundClickHelper.js';
export declare class ComplementaryClickHelper extends CompoundClickHelper {
    constructor();
    /**
     * Add a ClickHelper to the list of complementing ClickHelpers. Note that
     * duplicates are allowed.
     *
     * The intended way of using this is to, for example, create a ClickHelper,
     * use it normally, and add it when the widget is attached
     * (handleAttachment), and do the opposite when the widget is detached
     * (handleDetachment).
     */
    addClickHelper(clickHelper: BaseClickHelper): void;
    /**
     * Remove a ClickHelper from the list of complementing ClickHelpers.
     *
     * Depending on your use-case, you might also want to reset the ClickHelper
     * after removing it from this list.
     */
    removeClickHelper(clickHelper: BaseClickHelper): boolean;
}