Home | History | Annotate | Download | only in editing 
      1 /*
      2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple 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
      6  * are met:
      7  * 1. Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  * 2. Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef Caret_h
     27 #define Caret_h
     28 
     29 #include "core/editing/VisiblePosition.h"
     30 #include "platform/geometry/IntRect.h"
     31 #include "platform/geometry/LayoutRect.h"
     32 #include "wtf/Noncopyable.h"
     33 
     34 namespace WebCore {
     35 
     36 class Frame;
     37 class GraphicsContext;
     38 class RenderObject;
     39 class RenderView;
     40 
     41 class CaretBase {
     42     WTF_MAKE_NONCOPYABLE(CaretBase);
     43     WTF_MAKE_FAST_ALLOCATED;
     44 protected:
     45     enum CaretVisibility { Visible, Hidden };
     46     explicit CaretBase(CaretVisibility = Hidden);
     47 
     48     void invalidateCaretRect(Node*, bool caretRectChanged = false);
     49     void clearCaretRect();
     50     bool updateCaretRect(Document*, const VisiblePosition& caretPosition);
     51     IntRect absoluteBoundsForLocalRect(Node*, const LayoutRect&) const;
     52     bool shouldRepaintCaret(const RenderView*, bool isContentEditable) const;
     53     void paintCaret(Node*, GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
     54 
     55     const LayoutRect& localCaretRectWithoutUpdate() const { return m_caretLocalRect; }
     56 
     57     bool shouldUpdateCaretRect() const { return m_caretRectNeedsUpdate; }
     58     void setCaretRectNeedsUpdate() { m_caretRectNeedsUpdate = true; }
     59 
     60     void setCaretVisibility(CaretVisibility visibility) { m_caretVisibility = visibility; }
     61     bool caretIsVisible() const { return m_caretVisibility == Visible; }
     62     CaretVisibility caretVisibility() const { return m_caretVisibility; }
     63 
     64 protected:
     65     static RenderObject* caretRenderer(Node*);
     66     static void repaintCaretForLocalRect(Node*, const LayoutRect&);
     67 
     68 private:
     69     LayoutRect m_caretLocalRect; // caret rect in coords local to the renderer responsible for painting the caret
     70     bool m_caretRectNeedsUpdate; // true if m_caretRect (and m_absCaretBounds in FrameSelection) need to be calculated
     71     CaretVisibility m_caretVisibility;
     72 };
     73 
     74 class DragCaretController : private CaretBase {
     75     WTF_MAKE_NONCOPYABLE(DragCaretController);
     76     WTF_MAKE_FAST_ALLOCATED;
     77 public:
     78     static PassOwnPtr<DragCaretController> create();
     79 
     80     RenderObject* caretRenderer() const;
     81     void paintDragCaret(Frame*, GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
     82 
     83     bool isContentEditable() const { return m_position.rootEditableElement(); }
     84     bool isContentRichlyEditable() const;
     85 
     86     bool hasCaret() const { return m_position.isNotNull(); }
     87     const VisiblePosition& caretPosition() { return m_position; }
     88     void setCaretPosition(const VisiblePosition&);
     89     void clear() { setCaretPosition(VisiblePosition()); }
     90 
     91     void nodeWillBeRemoved(Node&);
     92 
     93 private:
     94     DragCaretController();
     95 
     96     VisiblePosition m_position;
     97 };
     98 
     99 } // namespace WebCore
    100 
    101 
    102 #endif // Caret_h
    103