/*

 * This file is part of the select element renderer in WebCore.

 *

 * Copyright (C) 2006, 2007 Apple 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. 

 * 3.  Neither the name of Apple Computer, Inc. ("Apple") 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 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 RenderListBox_h

#define RenderListBox_h

#include "RenderBlock.h"

#include "ScrollBar.h"

namespace WebCore {

class HTMLSelectElement;

class RenderListBox : public RenderBlock, private ScrollbarClient {

public:

    RenderListBox(HTMLSelectElement*);

    ~RenderListBox();

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

    virtual bool isListBox() const { return true; }

    virtual void setStyle(RenderStyle*);

    virtual void updateFromElement();

    virtual bool canHaveChildren() const { return false; }

    virtual bool hasControlClip() const { return true; }

    virtual void paintObject(PaintInfo&, int tx, int ty);

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

    virtual bool isPointInOverflowControl(HitTestResult&, int x, int y, int tx, int ty);

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

    virtual bool isScrollable() const;

    virtual void calcPrefWidths();

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

    virtual void calcHeight();

    virtual void layout();

    void selectionChanged();

    void setOptionsChanged(bool changed) { m_optionsChanged = changed; }

    int listIndexAtOffset(int x, int y);

    bool scrollToRevealElementAtListIndex(int index);

    virtual bool shouldAutoscroll() const { return true; }

    virtual void autoscroll();

    virtual void stopAutoscroll();

    virtual int verticalScrollbarWidth() const;

    virtual int scrollLeft() const;

    virtual int scrollTop() const;

    virtual int scrollWidth() const;

    virtual int scrollHeight() const;

    virtual void setScrollLeft(int);

    virtual void setScrollTop(int);

#if PLATFORM(SYMBIAN)

    IntRect itemRect(int tx, int ty, int index) { return itemBoundingBoxRect(tx, ty, index); }

    int indexOffset() {return m_indexOffset;}

#endif

private:

    // ScrollbarClient interface.

    virtual void valueChanged(Scrollbar*);

    virtual IntRect windowClipRect() const;

    int itemHeight() const;

    void valueChanged(unsigned listIndex);

    int size() const;

    int numVisibleItems() const;

    int numItems() const;

    int listHeight() const;

    IntRect itemBoundingBoxRect(int tx, int ty, int index);

    void paintScrollbar(PaintInfo&);

    void paintItemForeground(PaintInfo&, int tx, int ty, int listIndex);

    void paintItemBackground(PaintInfo&, int tx, int ty, int listIndex);

    bool listIndexIsVisible(int index);

    void scrollToRevealSelection();

    bool m_optionsChanged;

    bool m_scrollToRevealSelectionAfterLayout;

    bool m_inAutoscroll;

    int m_optionsWidth;

    int m_indexOffset;

    RefPtr<Scrollbar> m_vBar;

};

} // namepace WebCore

#endif // RenderListBox_h