Source/WebKit2/WebProcess/WebPage/FindController.h

   1 /*
   2  * Copyright (C) 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 INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef FindController_h
  27 #define FindController_h
  28
  29 #include "PageOverlay.h"
  30 #include "ShareableBitmap.h"
  31 #include "WebFindOptions.h"
  32 #include <WebCore/IntRect.h>
  33 #include <wtf/Forward.h>
  34 #include <wtf/Noncopyable.h>
  35 #include <wtf/Vector.h>
  36
  37 namespace WebCore {
  38     class Frame;
  39     class Range;
  40 }
  41
  42 namespace WebKit {
  43
  44 class WebPage;
  45
  46 class FindController : private PageOverlay::Client {
  47     WTF_MAKE_NONCOPYABLE(FindController);
  48
  49 public:
  50     explicit FindController(WebPage*);
  51     virtual ~FindController();
  52
  53     void findString(const String&, FindOptions, unsigned maxMatchCount);
  54     void findStringMatches(const String&, FindOptions, unsigned maxMatchCount);
  55     void getImageForFindMatch(uint32_t matchIndex);
  56     void selectFindMatch(uint32_t matchIndex);
  57     void hideFindUI();
  58     void countStringMatches(const String&, FindOptions, unsigned maxMatchCount);
  59
  60     void hideFindIndicator();
  61     void showFindIndicatorInSelection();
  62
  63     bool isShowingOverlay() const { return m_isShowingFindIndicator && m_findPageOverlay; }
  64
  65     void deviceScaleFactorDidChange();
  66
  67 private:
  68     // PageOverlay::Client.
  69     virtual void pageOverlayDestroyed(PageOverlay*);
  70     virtual void willMoveToWebPage(PageOverlay*, WebPage*);
  71     virtual void didMoveToWebPage(PageOverlay*, WebPage*);
  72     virtual bool mouseEvent(PageOverlay*, const WebMouseEvent&);
  73     virtual void drawRect(PageOverlay*, WebCore::GraphicsContext&, const WebCore::IntRect& dirtyRect);
  74
  75     Vector<WebCore::IntRect> rectsForTextMatches();
  76     bool getFindIndicatorBitmapAndRect(WebCore::Frame*, ShareableBitmap::Handle&, WebCore::IntRect& selectionRect);
  77     bool updateFindIndicator(WebCore::Frame* selectedFrame, bool isShowingOverlay, bool shouldAnimate = true);
  78
  79     void updateFindUIAfterPageScroll(bool found, const String&, FindOptions, unsigned maxMatchCount);
  80 #if ENABLE(TIZEN_FIND_STRING)
  81     void setActiveMatchHighlight(int activeMatchIndex);
  82 #endif
  83
  84     WebPage* m_webPage;
  85     PageOverlay* m_findPageOverlay;
  86
  87     // Whether the UI process is showing the find indicator. Note that this can be true even if
  88     // the find indicator isn't showing, but it will never be false when it is showing.
  89     bool m_isShowingFindIndicator;
  90     WebCore::IntRect m_findIndicatorRect;
  91     Vector<RefPtr<WebCore::Range> > m_findMatches;
  92
  93 #if ENABLE(TIZEN_FIND_STRING)
  94     String m_oldString;
  95     // The range of the active match for the current frame.
  96     RefPtr<WebCore::Range> m_activeMatch;
  97     // The index of the active match for the current frame.
  98     int m_activeMatchIndexInCurrentFrame;
  99 #endif
 100 };
 101
 102 } // namespace WebKit
 103
 104 #endif // FindController_h