public/web/WebTextInputInfo.h

/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebTextInputInfo_h
#define WebTextInputInfo_h

#include "../platform/WebString.h"
#include "WebTextInputType.h"

namespace WebKit {

struct WebTextInputInfo {
    WebTextInputType type;

    // The value of the currently focused input field.
    WebString value;

    // The cursor position of the current selection start, or the caret position
    // if nothing is selected.
    int selectionStart;

    // The cursor position of the current selection end, or the caret position
    // if nothing is selected.
    int selectionEnd;

    // The start position of the current composition, or -1 if there is none.
    int compositionStart;

    // The end position of the current composition, or -1 if there is none.
    int compositionEnd;

    // The inputmode attribute value of the currently focused input field.
    // This string is lower-case.
    WebString inputMode;

    WEBKIT_EXPORT bool equals(const WebTextInputInfo&) const;

    WebTextInputInfo()
        : type(WebTextInputTypeNone)
        , selectionStart(0)
        , selectionEnd(0)
        , compositionStart(-1)
        , compositionEnd(-1)
    {
    }
};

inline bool operator==(const WebTextInputInfo& a, const WebTextInputInfo& b)
{
    return a.equals(b);
}

inline bool operator!=(const WebTextInputInfo& a, const WebTextInputInfo& b)
{
    return !(a == b);
}

} // namespace WebKit

#endif