File: pdf_viewer_private.idl

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (77 lines) | stat: -rw-r--r-- 2,980 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Use the <code>chrome.pdfViewerPrivate</code> API for specific browser
// functionality that the PDF Viewer needs from outside the PDF plugin. This API
// is exclusively for the PDF Viewer.
namespace pdfViewerPrivate {
  // Nearly identical to mimeHandlerPrivate.StreamInfo, but without a mime type
  // nor a response header field. Those fields are unused by the PDF viewer.
  dictionary StreamInfo {
    // The original URL that was intercepted.
    DOMString originalUrl;

    // The URL that the stream can be read from.
    DOMString streamUrl;

    // The ID of the tab that opened the stream. If the stream is not opened in
    // a tab, it will be -1.
    long tabId;

    // Whether the stream is embedded within another document.
    boolean embedded;
  };

  // Identical to mimeHandlerPrivate.StreamInfo.
  dictionary PdfPluginAttributes {
    // The background color in ARGB format for painting. Since the background
    // color is an unsigned 32-bit integer which can be outside the range of
    // "long" type, define it as a "double" type here.
    double backgroundColor;

    // Indicates whether the plugin allows to execute JavaScript and maybe XFA.
    // Loading XFA for PDF forms will automatically be disabled if this flag is
    // false.
    boolean allowJavascript;
  };

  callback GetStreamInfoCallback = void(StreamInfo streamInfo);
  callback IsAllowedLocalFileAccessCallback = void(boolean result);
  callback VoidCallback = void();

  interface Functions {
    // Returns the StreamInfo for the stream for this context if there is one.
    static void getStreamInfo(
        GetStreamInfoCallback callback);

    // Determines if the given URL should be allowed to access local files from
    // the PDF Viewer. |callback|: Called with true if URL should be allowed to
    // access local files from the PDF Viewer, false otherwise.
    static void isAllowedLocalFileAccess(
        DOMString url,
        IsAllowedLocalFileAccessCallback callback);

    // Sets the current tab title to `title` for a full-page PDF.
    static void setPdfDocumentTitle(
        DOMString title,
        optional VoidCallback callback);

    // Sets PDF plugin attributes in the stream for this context if there is
    // one.
    static void setPdfPluginAttributes(
        PdfPluginAttributes attributes,
        optional VoidCallback callback);
  };

  interface Events {
    // Fired when the browser wants the listener to perform a save.
    // `streamUrl`: Unique ID for the instance that should perform the save.
    static void onSave(DOMString streamUrl);

    // Fired when the browser wants the listener to update the viewport based on
    // a different PDF URL.
    // `pdfUrl`: The string of the PDF URL that should update the viewport.
    static void onShouldUpdateViewport(DOMString pdfUrl);
  };
};