Source/WebCore/page/PagePopupClient.h

   1 /*
   2  * Copyright (C) 2012 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 PagePopupClient_h
  32 #define PagePopupClient_h
  33
  34 #if ENABLE(PAGE_POPUP)
  35
  36 #include "DocumentWriter.h"
  37 #include "IntSize.h"
  38 #include <wtf/text/WTFString.h>
  39
  40 namespace WebCore {
  41
  42 class DocumentWriter;
  43
  44 class PagePopupClient {
  45 public:
  46     virtual IntSize contentSize() = 0;
  47
  48     // Provide an HTML source through the specified DocumentWriter. The HTML
  49     // source is rendered in a PagePopup.
  50     // The content HTML supports:
  51     //  - No <select> popups
  52     //  - window.setValueAndClosePopup(number, string).
  53     virtual void writeDocument(DocumentWriter&) = 0;
  54
  55     // This is called by the content HTML of a PagePopup.
  56     // An implementation of this function should call ChromeClient::closePagePopup().
  57     virtual void setValueAndClosePopup(int numValue, const String& stringValue) = 0;
  58
  59     // This is called whenever a PagePopup was closed.
  60     virtual void didClosePopup() = 0;
  61
  62     virtual ~PagePopupClient() { }
  63
  64     // Helper functions to be used in PagePopupClient::writeDocument().
  65     static void addString(const String&, DocumentWriter&);
  66     static void addJavaScriptString(const String&, DocumentWriter&);
  67     static void addProperty(const char* name, const String& value, DocumentWriter&);
  68     static void addProperty(const char* name, unsigned value, DocumentWriter&);
  69     static void addProperty(const char* name, bool value, DocumentWriter&);
  70     static void addProperty(const char* name, const Vector<String>& values, DocumentWriter&);
  71 };
  72
  73 inline void PagePopupClient::addString(const String& str, DocumentWriter& writer)
  74 {
  75     CString str8 = str.utf8();
  76     writer.addData(str8.data(), str8.length());
  77 }
  78
  79 }
  80 #endif
  81 #endif