public/web/WebTextFieldDecoratorClient.h

/*
 * Copyright (C) 2012 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
 * OWNER OR 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 WebTextFieldDecoratorClient_h
#define WebTextFieldDecoratorClient_h

#include "../platform/WebCString.h"
#include "WebPasswordGeneratorClient.h"

namespace WebKit {

// FIXME: This is only here until the Chromium side change removes the usage in
// favor of WebPasswordGeneratorClient.
class WebTextFieldDecoratorClient : public WebPasswordGeneratorClient {
public:
    // Delegate to the handleClick method until the Chrome side patch can land.
    virtual void openPasswordGenerator(WebInputElement& input) { handleClick(input); }

    // This is called when the decoration icon is clicked.
    virtual void handleClick(WebInputElement&) = 0;

    // FIXME: These are never called.
    virtual void willDetach(const WebInputElement&) = 0;
    virtual bool visibleByDefault() = 0;
    virtual WebCString imageNameForReadOnlyState() = 0;
    virtual WebCString imageNameForDisabledState() = 0;
    virtual bool shouldAddDecorationTo(const WebInputElement&) = 0;
    virtual WebCString imageNameForNormalState() = 0;
    virtual WebCString imageNameForHoverState() = 0;

    virtual ~WebTextFieldDecoratorClient() { }
};

}

#endif // WebTextFieldDecoratorClient_h