Home | History | Annotate | Download | only in chromium
      1 /*
      2  * Copyright (c) 2008, 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 FramelessScrollView_h
     32 #define FramelessScrollView_h
     33 
     34 #include "ScrollView.h"
     35 
     36 namespace WebCore {
     37 
     38     class FramelessScrollViewClient;
     39     class PlatformKeyboardEvent;
     40     class PlatformMouseEvent;
     41     class PlatformWheelEvent;
     42 
     43     // A FramelessScrollView is a ScrollView that can be used to render custom
     44     // content, which does not have an associated Frame.
     45     //
     46     // NOTE: It may be better to just develop a custom subclass of Widget that
     47     // can have scroll bars for this instead of trying to reuse ScrollView.
     48     //
     49     class FramelessScrollView : public ScrollView {
     50     public:
     51         FramelessScrollView() : m_client(0) {}
     52         ~FramelessScrollView();
     53 
     54         FramelessScrollViewClient* client() const { return m_client; }
     55         void setClient(FramelessScrollViewClient* client) { m_client = client; }
     56 
     57         // Event handlers that subclasses must implement.
     58         virtual bool handleMouseDownEvent(const PlatformMouseEvent&) = 0;
     59         virtual bool handleMouseMoveEvent(const PlatformMouseEvent&) = 0;
     60         virtual bool handleMouseReleaseEvent(const PlatformMouseEvent&) = 0;
     61         virtual bool handleWheelEvent(const PlatformWheelEvent&) = 0;
     62         virtual bool handleKeyEvent(const PlatformKeyboardEvent&) = 0;
     63 
     64         // ScrollbarClient public methods:
     65         virtual void invalidateScrollbarRect(Scrollbar*, const IntRect&);
     66         virtual bool isActive() const;
     67 
     68         // Widget public methods:
     69         virtual void invalidateRect(const IntRect&);
     70 
     71         // ScrollView public methods:
     72         virtual HostWindow* hostWindow() const;
     73         virtual IntRect windowClipRect(bool clipToContents = true) const;
     74 
     75     protected:
     76         // ScrollView protected methods:
     77         virtual void paintContents(GraphicsContext*, const IntRect& damageRect);
     78         virtual void contentsResized();
     79         virtual void visibleContentsResized();
     80 
     81     private:
     82         FramelessScrollViewClient* m_client;
     83     };
     84 
     85 } // namespace WebCore
     86 
     87 #endif
     88