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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* This file defines the <code>PPB_FileChooser_Dev</code> interface.
*/
[generate_thunk]
label Chrome {
M16 = 0.5,
M19 = 0.6
};
/**
* This enumeration contains constants to control the behavior of the file
* chooser dialog.
*/
[assert_size(4)]
enum PP_FileChooserMode_Dev {
/**
* Mode for choosing a single existing file.
*/
PP_FILECHOOSERMODE_OPEN = 0,
/**
* Mode for choosing multiple existing files.
*/
PP_FILECHOOSERMODE_OPENMULTIPLE = 1
};
interface PPB_FileChooser_Dev {
/**
* This function creates a file chooser dialog resource. The chooser is
* associated with a particular instance, so that it may be positioned on the
* screen relative to the tab containing the instance.
*
* @param[in] instance A <code>PP_Instance</code> identifying one instance
* of a module.
* @param[in] mode A <code>PP_FileChooserMode_Dev</code> value that controls
* the behavior of the file chooser dialog.
* @param[in] accept_types A comma-separated list of MIME types and file
* extensions such as "audio/ *,text/plain,.html" (note there should be no
* space between the '/' and the '*', but one is added to avoid confusing C++
* comments). The dialog may restrict selectable files to the specified MIME
* types and file extensions. If a string in the comma-separated list begins
* with a period (.) then the string is interpreted as a file extension,
* otherwise it is interpreted as a MIME-type. An empty string or an undefined
* var may be given to indicate that all types should be accepted.
*
* @return A <code>PP_Resource</code> containing the file chooser if
* successful or 0 if it could not be created.
*/
PP_Resource Create(
[in] PP_Instance instance,
[in] PP_FileChooserMode_Dev mode,
[in] PP_Var accept_types);
/**
* Determines if the provided resource is a file chooser.
*
* @param[in] resource A <code>PP_Resource</code> corresponding to a generic
* resource.
*
* @return A <code>PP_Bool</code> that is <code>PP_TRUE</code> if the given
* resource is a file chooser resource, otherwise <code>PP_FALSE</code>.
*/
PP_Bool IsFileChooser(
[in] PP_Resource resource);
/**
* This function displays a previously created file chooser resource as a
* dialog box, prompting the user to choose a file or files. This function
* must be called in response to a user gesture, such as a mouse click or
* touch event. The callback is called with PP_OK on successful completion
* with a file (or files) selected, PP_ERROR_USERCANCEL if the user selected
* no file, or another error code from pp_errors.h on failure.
*
* <b>Subtle note:</b> This function will only work when the tab containing
* the plugin is visible. Show will fail if the tab is in the background.
* Since it's not normally possible to get input events while invisible, this
* is not an issue. But there is a race condition because events are
* processed asynchronously that authors should be aware of. If the user
* clicks and switches tabs very quickly, a plugin could believe the tab is
* visible while Chrome believes it is invisible and the Show() call will
* fail. This will not generally cause user confusion since the user will
* have switched tabs and will not want to see a file chooser from a
* different tab.
*
* @param[in] chooser The file chooser resource.
* @param[in] callback A <code>CompletionCallback</code> to be called after
* the user has closed the file chooser dialog.
*
* @return PP_OK_COMPLETIONPENDING if request to show the dialog was
* successful, another error code from pp_errors.h on failure.
*/
[deprecate=0.6]
int32_t Show(
[in] PP_Resource chooser,
[in] PP_CompletionCallback callback);
/**
* After a successful completion callback call from Show, this method may be
* used to query the chosen files. It should be called in a loop until it
* returns 0. Their file system type will be PP_FileSystemType_External. If
* the user chose no files or canceled the dialog, then this method will
* simply return 0 the first time it is called.
*
* @param[in] chooser The file chooser resource.
*
* @return A <code>PP_Resource</code> containing the next file chosen by the
* user, or 0 if there are no more files.
*/
[deprecate=0.6]
PP_Resource GetNextChosenFile(
[in] PP_Resource chooser);
/**
* This function displays a previously created file chooser resource as a
* dialog box, prompting the user to choose a file or files. This function
* must be called in response to a user gesture, such as a mouse click or
* touch event. The callback is called with PP_OK on successful completion
* with a file (or files) selected, PP_ERROR_USERCANCEL if the user selected
* no file, or another error code from pp_errors.h on failure.
*
* <b>Subtle note:</b> This function will only work when the tab containing
* the plugin is visible. Show() will fail if the tab is in the background.
* Since it's not normally possible to get input events while invisible, this
* is not normally an issue. But there is a race condition because events are
* processed asynchronously. If the user clicks and switches tabs very
* quickly, a plugin could believe the tab is visible while Chrome believes
* it is invisible and the Show() call will fail. This will not generally
* cause user confusion since the user will have switched tabs and will not
* want to see a file chooser from a different tab.
*
* @param[in] chooser The file chooser resource.
*
* @param[in] output An output array which will receive PP_Resource(s)
* identifying the <code>PPB_FileRef</code> objects that the user selected on
* success.
*
* @param[in] callback A <code>CompletionCallback</code> to be called after
* the user has closed the file chooser dialog.
*
* @return PP_OK_COMPLETIONPENDING if request to show the dialog was
* successful, another error code from pp_errors.h on failure.
*/
[version=0.6]
int32_t Show([in] PP_Resource chooser,
[in] PP_ArrayOutput output,
[in] PP_CompletionCallback callback);
};
|
