Home | History | Annotate | Download | only in page
      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 #include "core/loader/DocumentWriter.h"
     35 #include "core/platform/graphics/IntRect.h"
     36 #include "wtf/text/CString.h"
     37 #include "wtf/text/WTFString.h"
     38 
     39 namespace WebCore {
     40 
     41 class DocumentWriter;
     42 class Locale;
     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     // Returns a Locale object associated to the client.
     56     virtual Locale& locale() = 0;
     57 
     58     // This is called by the content HTML of a PagePopup.
     59     // An implementation of this function should call ChromeClient::closePagePopup().
     60     virtual void setValueAndClosePopup(int numValue, const String& stringValue) = 0;
     61 
     62     // This is called by the content HTML of a PagePopup.
     63     virtual void setValue(const String&) = 0;
     64 
     65     // This is called by the content HTML of a PagePopup.
     66     virtual void closePopup() = 0;
     67 
     68     // This is called whenever a PagePopup was closed.
     69     virtual void didClosePopup() = 0;
     70 
     71     virtual ~PagePopupClient() { }
     72 
     73     // Helper functions to be used in PagePopupClient::writeDocument().
     74     static void addString(const String&, DocumentWriter&);
     75     static void addJavaScriptString(const String&, DocumentWriter&);
     76     static void addProperty(const char* name, const String& value, DocumentWriter&);
     77     static void addProperty(const char* name, int value, DocumentWriter&);
     78     static void addProperty(const char* name, unsigned value, DocumentWriter&);
     79     static void addProperty(const char* name, bool value, DocumentWriter&);
     80     static void addProperty(const char* name, const Vector<String>& values, DocumentWriter&);
     81     static void addProperty(const char* name, const IntRect&, DocumentWriter&);
     82 };
     83 
     84 inline void PagePopupClient::addString(const String& str, DocumentWriter& writer)
     85 {
     86     CString str8 = str.utf8();
     87     writer.addData(str8.data(), str8.length());
     88 }
     89 
     90 }
     91 #endif
     92