src/third_party/WebKit/public/web/WebFileChooserCompletion.h

   1 /*
   2  * Copyright (C) 2009 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 WebFileChooserCompletion_h
  32 #define WebFileChooserCompletion_h
  33
  34 #include "../platform/WebString.h"
  35 #include "../platform/WebURL.h"
  36
  37 namespace blink {
  38
  39 template <typename T> class WebVector;
  40
  41 // Gets called back when WebViewClient finished choosing a file.
  42 class WebFileChooserCompletion {
  43 public:
  44     struct SelectedFileInfo {
  45         // The actual path of the selected file.
  46         WebString path;
  47
  48         // The display name of the file that is to be exposed as File.name in
  49         // the DOM layer. If it is empty the base part of the |path| is used.
  50         WebString displayName;
  51
  52         // File system URL.
  53         WebURL fileSystemURL;
  54
  55         // Metadata of non-native file.
  56         // 0 is Unix epoch, unit is sec.
  57         double modificationTime;
  58         long long length;
  59         bool isDirectory;
  60
  61         SelectedFileInfo()
  62             : modificationTime(0)
  63             , length(0)
  64             , isDirectory(false)
  65         {
  66         }
  67     };
  68
  69     // Called with zero or more file names. Zero-lengthed vector means that
  70     // the user cancelled or that file choosing failed. The callback instance
  71     // is destroyed when this method is called.
  72     virtual void didChooseFile(const WebVector<WebString>& fileNames) = 0;
  73
  74     // Called with zero or more files, given as a vector of SelectedFileInfo.
  75     // Zero-lengthed vector means that the user cancelled or that file
  76     // choosing failed. The callback instance is destroyed when this method
  77     // is called.
  78     // FIXME: Deprecate either one of the didChooseFile (and rename it to
  79     // didChooseFile*s*).
  80     virtual void didChooseFile(const WebVector<SelectedFileInfo>&) { }
  81 protected:
  82     virtual ~WebFileChooserCompletion() {}
  83 };
  84
  85 } // namespace blink
  86
  87 #endif