third_party/WebKit/public/web/WebSearchableFormData.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 WebSearchableFormData_h
  32 #define WebSearchableFormData_h
  33
  34 #include "../platform/WebString.h"
  35 #include "../platform/WebURL.h"
  36 #include "WebInputElement.h"
  37
  38 namespace blink {
  39
  40 class WebFormElement;
  41
  42 // SearchableFormData encapsulates a URL and encoding of an INPUT field that
  43 // corresponds to a searchable form request.
  44 class WebSearchableFormData {
  45 public:
  46     // If the provided form is suitable for automated searching, isValid()
  47     // will return false.
  48     BLINK_EXPORT WebSearchableFormData(const WebFormElement&, const WebInputElement& selectedInputElement = WebInputElement());
  49
  50     bool isValid() { return m_url.isValid(); }
  51
  52     // URL for the searchable form request.
  53     const WebURL& url() const
  54     {
  55         return m_url;
  56     }
  57
  58     // Encoding used to encode the form parameters; never empty.
  59     const WebString& encoding() const
  60     {
  61         return m_encoding;
  62     }
  63
  64 private:
  65     WebURL m_url;
  66     WebString m_encoding;
  67 };
  68
  69 } // namespace blink
  70
  71 #endif