third_party/WebKit/public/web/WebFileChooserParams.h

   1 /*
   2  * Copyright (C) 2010, 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebFileChooserParams_h
  32 #define WebFileChooserParams_h
  33
  34 #include "../platform/WebString.h"
  35 #include "../platform/WebVector.h"
  36 #include "WebFileChooserCompletion.h"
  37
  38 namespace blink {
  39
  40 struct WebFileChooserParams {
  41     // If |multiSelect| is true, the dialog allows the user to select multiple files.
  42     bool multiSelect;
  43     // If |directory| is true, the dialog allows the user to select a directory.
  44     bool directory;
  45     // If |saveAs| is true, the dialog allows the user to select a possibly
  46     // non-existent file. This can be used for a "Save As" dialog.
  47     bool saveAs;
  48     // |title| is the title for a file chooser dialog. It can be an empty string.
  49     WebString title;
  50     // |initialValue| is a filename which the dialog should select by default.
  51     // It can be an empty string.
  52     WebString initialValue;
  53     // This contains MIME type strings such as "audio/*" "text/plain" or file
  54     // extensions beginning with a period (.) such as ".mp3" ".txt".
  55     // The dialog may restrict selectable files to files with the specified MIME
  56     // types or file extensions.
  57     // This list comes from an 'accept' attribute value of an INPUT element, and
  58     // it contains only lower-cased MIME type strings and file extensions.
  59     WebVector<WebString> acceptTypes;
  60     // |selectedFiles| has filenames which a file upload control already selected.
  61     // A WebViewClient implementation may ask a user to select
  62     //  - removing a file from the selected files,
  63     //  - appending other files, or
  64     //  - replacing with other files
  65     // before opening a file chooser dialog.
  66     WebVector<WebString> selectedFiles;
  67     // See http://www.w3.org/TR/html-media-capture/ for the semantics of the
  68     // capture attribute. If |useMediaCapture| is true, the media types
  69     // indicated in |acceptTypes| should be obtained from the device's
  70     // environment using a media capture mechanism. |capture| is deprecated and
  71     // provided for compatibility reasons.
  72     WebString capture;
  73     bool useMediaCapture;
  74     // Whether WebFileChooserCompletion needs local paths or not. If the result
  75     // of file chooser is handled by the implementation of
  76     // WebFileChooserCompletion that can handle files without local paths,
  77     // 'false' should be specified to the flag.
  78     bool needLocalPath;
  79
  80     WebFileChooserParams()
  81         : multiSelect(false)
  82         , directory(false)
  83         , saveAs(false)
  84         , useMediaCapture(false)
  85         , needLocalPath(true)
  86     {
  87     }
  88 };
  89
  90 } // namespace blink
  91
  92 #endif