third_party/WebKit/Source/platform/FileChooser.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 Apple 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
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  */
  29
  30 #ifndef FileChooser_h
  31 #define FileChooser_h
  32
  33 #include "platform/FileMetadata.h"
  34 #include "platform/PlatformExport.h"
  35 #include "platform/weborigin/KURL.h"
  36 #include "wtf/RefCounted.h"
  37 #include "wtf/Vector.h"
  38 #include "wtf/text/WTFString.h"
  39
  40 namespace blink {
  41
  42 class FileChooser;
  43
  44 struct FileChooserFileInfo {
  45     FileChooserFileInfo(const String& path, const String& displayName = String())
  46         : path(path)
  47         , displayName(displayName)
  48     {
  49     }
  50
  51     FileChooserFileInfo(const KURL& fileSystemURL, const FileMetadata metadata) : fileSystemURL(fileSystemURL), metadata(metadata)
  52     {
  53     }
  54
  55     // Members for native files.
  56     const String path;
  57     const String displayName;
  58
  59     // Members for file system API files.
  60     const KURL fileSystemURL;
  61     const FileMetadata metadata;
  62 };
  63
  64 struct FileChooserSettings {
  65     bool allowsMultipleFiles;
  66     bool allowsDirectoryUpload;
  67     Vector<String> acceptMIMETypes;
  68     Vector<String> acceptFileExtensions;
  69     Vector<String> selectedFiles;
  70     bool useMediaCapture;
  71
  72     // Returns a combined vector of acceptMIMETypes and acceptFileExtensions.
  73     Vector<String> PLATFORM_EXPORT acceptTypes() const;
  74 };
  75
  76 class PLATFORM_EXPORT FileChooserClient {
  77 public:
  78     virtual void filesChosen(const Vector<FileChooserFileInfo>&) = 0;
  79     virtual ~FileChooserClient();
  80
  81 protected:
  82     FileChooser* newFileChooser(const FileChooserSettings&);
  83
  84 private:
  85     void discardChooser();
  86
  87     RefPtr<FileChooser> m_chooser;
  88 };
  89
  90 class PLATFORM_EXPORT FileChooser : public RefCounted<FileChooser> {
  91 public:
  92     static PassRefPtr<FileChooser> create(FileChooserClient*, const FileChooserSettings&);
  93     ~FileChooser();
  94
  95     void disconnectClient() { m_client = 0; }
  96
  97     // FIXME: We should probably just pass file paths that could be virtual paths with proper display names rather than passing structs.
  98     void chooseFiles(const Vector<FileChooserFileInfo>& files);
  99
 100     const FileChooserSettings& settings() const { return m_settings; }
 101
 102 private:
 103     FileChooser(FileChooserClient*, const FileChooserSettings&);
 104
 105     FileChooserClient* m_client;
 106     FileChooserSettings m_settings;
 107 };
 108
 109 } // namespace blink
 110
 111 #endif // FileChooser_h