jupyterlab-emrys/lib/filebrowser/buttons.d.ts

A computational environment for Jupyter. Powered by Emrys

import { IKernel } from 'jupyter-js-services';
import { Widget } from 'phosphor-widget';
import { DocumentManager } from '../docmanager';
import { FileBrowserModel } from './model';
import { IWidgetOpener } from './browser';
/**
 * A widget which hosts the file browser buttons.
 */
export declare class FileButtons extends Widget {
    /**
     * Construct a new file browser buttons widget.
     *
     * @param model - The file browser view model.
     */
    constructor(options: FileButtons.IOptions);
    /**
     * Dispose of the resources held by the widget.
     */
    dispose(): void;
    /**
     * Get the model used by the widget.
     *
     * #### Notes
     * This is a read-only property.
     */
    model: FileBrowserModel;
    /**
     * Get the document manager used by the widget.
     */
    manager: DocumentManager;
    /**
     * Open a file by path.
     */
    open(path: string, widgetName?: string, kernel?: IKernel.IModel): void;
    /**
     * Create a new file by path.
     */
    createNew(path: string, widgetName?: string, kernel?: IKernel.IModel): void;
    /**
     * The 'mousedown' handler for the create button.
     */
    private _onCreateButtonPressed;
    /**
     * The 'click' handler for the upload button.
     */
    private _onUploadButtonClicked;
    /**
     * The 'click' handler for the refresh button.
     */
    private _onRefreshButtonClicked;
    /**
     * The 'change' handler for the input field.
     */
    private _onInputChanged;
    private _model;
    private _buttons;
    private _input;
    private _manager;
    private _opener;
}
/**
 * The namespace for the `FileButtons` class statics.
 */
export declare namespace FileButtons {
    /**
     * An options object for initializing a file buttons widget.
     */
    interface IOptions {
        /**
         * A file browser model instance.
         */
        model: FileBrowserModel;
        /**
         * A document manager instance.
         */
        manager: DocumentManager;
        /**
         * A widget opener function.
         */
        opener: IWidgetOpener;
    }
}