/* Copyright 2014 Mozilla Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

/**
 * @interface
 */
function IPDFLinkService() {
}

IPDFLinkService.prototype = {
    /**
     * @returns {number}
     */
    get page() {
    },
    /**
     * @param {number} value
     */
    set page(value) {
    },
    /**
     * @param dest - The PDF destination object.
     */
    navigateTo         : function(dest) {
    },
    /**
     * @param dest - The PDF destination object.
     * @returns {string} The hyperlink to the PDF object.
     */
    getDestinationHash : function(dest) {
    },
    /**
     * @param hash - The PDF parameters/hash.
     * @returns {string} The hyperlink to the PDF object.
     */
    getAnchorUrl       : function(hash) {
    },
    /**
     * @param {string} hash
     */
    setHash            : function(hash) {
    },
    /**
     * @param {string} action
     */
    executeNamedAction : function(action) {
    },

    /**
     * @param {number} pageNum - page number.
     * @param {Object} pageRef - reference to the page.
     */
    cachePageRef : function(pageNum, pageRef) {
    },
};

/**
 * @interface
 */
function IPDFHistory() {
}

IPDFHistory.prototype = {
    forward             : function() {
    },
    back                : function() {
    },
    push                : function(params) {
    },
    updateNextHashParam : function(hash) {
    },
};

/**
 * @interface
 */
function IRenderableView() {
}

IRenderableView.prototype = {
    /**
     * @returns {string} - Unique ID for rendering queue.
     */
    get renderingId() {
    },
    /**
     * @returns {RenderingStates}
     */
    get renderingState() {
    },
    /**
     * @returns {Promise} Resolved on draw completion.
     */
    draw   : function() {
    },
    resume : function() {
    },
};

/**
 * @interface
 */
function IPDFTextLayerFactory() {
}

IPDFTextLayerFactory.prototype = {
    /**
     * @param {HTMLDivElement} textLayerDiv
     * @param {number} pageIndex
     * @param {PageViewport} viewport
     * @returns {TextLayerBuilder}
     */
    createTextLayerBuilder : function(textLayerDiv, pageIndex, viewport) {
    }
};

/**
 * @interface
 */
function IPDFAnnotationLayerFactory() {
}

IPDFAnnotationLayerFactory.prototype = {
    /**
     * @param {HTMLDivElement} pageDiv
     * @param {PDFPage} pdfPage
     * @returns {AnnotationLayerBuilder}
     */
    createAnnotationLayerBuilder : function(pageDiv, pdfPage) {
    }
};
