/*

 * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.s

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public License

 * along with this library; see the file COPYING.LIB.  If not, write to

 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,

 * Boston, MA 02110-1301, USA.

 *

 */

#ifndef RenderTextControl_h

#define RenderTextControl_h

#include "PopupMenuClient.h"

#include "RenderBlock.h"

#include "Timer.h"

namespace WebCore {

class HTMLTextFieldInnerElement;

class HTMLTextFieldInnerTextElement;

class HTMLSearchFieldCancelButtonElement;

class HTMLSearchFieldResultsButtonElement;

class SearchPopupMenu;

class Selection;

class RenderTextControl : public RenderBlock, private PopupMenuClient {

public:

    RenderTextControl(Node*, bool multiLine);

    virtual ~RenderTextControl();

    virtual const char* renderName() const { return "RenderTextControl"; }

    virtual bool hasControlClip() const { return m_cancelButton; }

    virtual IntRect controlClipRect(int tx, int ty) const;

    virtual void calcHeight();

    virtual void calcPrefWidths();

    virtual void removeLeftoverAnonymousBlock(RenderBlock*) { }

    virtual void setStyle(RenderStyle*);

    virtual void updateFromElement();

    virtual bool canHaveChildren() const { return false; }

    virtual short baselinePosition(bool firstLine, bool isRootLineBox) const;

    virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);

    virtual void layout();

    virtual bool avoidsFloats() const { return true; }

    virtual bool isEdited() const { return m_dirty; }

    virtual void setEdited(bool isEdited) { m_dirty = isEdited; }

    virtual bool isTextField() const { return !m_multiLine; }

    virtual bool isTextArea() const { return m_multiLine; }

    bool isUserEdited() const { return m_userEdited; }

    void setUserEdited(bool isUserEdited) { m_userEdited = isUserEdited; }

    int selectionStart();

    int selectionEnd();

    void setSelectionStart(int);

    void setSelectionEnd(int);

    void select();

    void setSelectionRange(int start, int end);

    Selection selection(int start, int end) const;

    void subtreeHasChanged();

    String text();

    String textWithHardLineBreaks();

    void forwardEvent(Event*);

    void selectionChanged(bool userTriggered);

    virtual bool shouldAutoscroll() const { return true; }

    virtual void autoscroll();

    // Subclassed to forward to our inner div.

    virtual int scrollLeft() const;

    virtual int scrollTop() const;

    virtual int scrollWidth() const;

    virtual int scrollHeight() const;

    virtual void setScrollLeft(int);

    virtual void setScrollTop(int);

    virtual bool scroll(ScrollDirection, ScrollGranularity, float multiplier = 1.0f);

    virtual bool isScrollable() const;

    VisiblePosition visiblePositionForIndex(int index);

    int indexForVisiblePosition(const VisiblePosition&);

    void addSearchResult();

    bool popupIsVisible() const { return m_searchPopupIsVisible; }

    void showPopup();

    void hidePopup();

    void stopSearchEventTimer();

    bool placeholderIsVisible() const { return m_placeholderVisible; }

private:

    // PopupMenuClient methods

    virtual void valueChanged(unsigned listIndex, bool fireEvents = true);

    virtual String itemText(unsigned listIndex) const;

    virtual bool itemIsEnabled(unsigned listIndex) const;

    virtual Color itemBackgroundColor(unsigned listIndex) const;

    virtual RenderStyle* itemStyle(unsigned listIndex) const;

    virtual RenderStyle* clientStyle() const;

    virtual Document* clientDocument() const;

    virtual int clientPaddingLeft() const;

    virtual int clientPaddingRight() const;

    virtual int listSize() const;

    virtual int selectedIndex() const;

    virtual bool itemIsSeparator(unsigned listIndex) const;

    virtual bool itemIsLabel(unsigned listIndex) const;

    virtual bool itemIsSelected(unsigned listIndex) const;

    virtual void setTextFromItem(unsigned listIndex);

    virtual bool shouldPopOver() const { return false; }

    virtual bool valueShouldChangeOnHotTrack() const { return false; }

    RenderStyle* createInnerBlockStyle(RenderStyle* startStyle);

    RenderStyle* createInnerTextStyle(RenderStyle* startStyle);

    RenderStyle* createCancelButtonStyle(RenderStyle* startStyle);

    RenderStyle* createResultsButtonStyle(RenderStyle* startStyle);

    void updatePlaceholder();

    void createSubtreeIfNeeded();

    void updateCancelButtonVisibility(RenderStyle*);

    const AtomicString& autosaveName() const;

    void startSearchEventTimer();

    void searchEventTimerFired(Timer<RenderTextControl>*);

    String finishText(Vector<UChar>&) const;

    RefPtr<HTMLTextFieldInnerElement> m_innerBlock;

    RefPtr<HTMLTextFieldInnerTextElement> m_innerText;

    RefPtr<HTMLSearchFieldResultsButtonElement> m_resultsButton;

    RefPtr<HTMLSearchFieldCancelButtonElement> m_cancelButton;

    bool m_dirty;

    bool m_multiLine;

    bool m_placeholderVisible;

    bool m_userEdited;

    RefPtr<SearchPopupMenu> m_searchPopup;

    bool m_searchPopupIsVisible;

    mutable Vector<String> m_recentSearches;

    Timer<RenderTextControl> m_searchEventTimer;

};

} // namespace WebCore

#endif // RenderTextControl_h