src/third_party/WebKit/Source/web/ExternalPopupMenu.h

   1 /*
   2  * Copyright (C) 2010 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 ExternalPopupMenu_h
  32 #define ExternalPopupMenu_h
  33
  34 #include "platform/PopupMenu.h"
  35 #include "platform/Timer.h"
  36 #include "public/platform/WebCanvas.h"
  37 #include "public/platform/WebScrollbar.h"
  38 #include "public/web/WebExternalPopupMenuClient.h"
  39
  40 namespace blink {
  41
  42 class FloatQuad;
  43 class IntSize;
  44 class LocalFrame;
  45 class PopupMenuClient;
  46 class WebExternalPopupMenu;
  47 class WebMouseEvent;
  48 class WebViewImpl;
  49 struct WebPopupMenuInfo;
  50
  51 // The ExternalPopupMenu connects the actual implementation of the popup menu
  52 // to the WebCore popup menu.
  53 class ExternalPopupMenu final : public PopupMenu, public WebExternalPopupMenuClient {
  54 public:
  55     ExternalPopupMenu(LocalFrame&, PopupMenuClient*, WebViewImpl&);
  56     virtual ~ExternalPopupMenu();
  57
  58     // Fills |info| with the popup menu information contained in the
  59     // PopupMenuClient associated with this ExternalPopupMenu.
  60     // FIXME: public only for test access. Need to revert once gtest
  61     // helpers from chromium are available for blink.
  62     static void getPopupMenuInfo(WebPopupMenuInfo&, PopupMenuClient&);
  63     static int toPopupMenuItemIndex(int index, PopupMenuClient&);
  64     static int toExternalPopupMenuItemIndex(int index, PopupMenuClient&);
  65
  66     virtual void trace(Visitor*) override;
  67
  68 private:
  69     // PopupMenu methods:
  70     virtual void show(const FloatQuad& controlPosition, const IntSize&, int index) override;
  71     virtual void hide() override;
  72     virtual void updateFromElement() override;
  73     virtual void disconnectClient() override;
  74
  75     // WebExternalPopupClient methods:
  76     virtual void didChangeSelection(int index) override;
  77     virtual void didAcceptIndex(int index) override;
  78     virtual void didAcceptIndices(const WebVector<int>& indices) override;
  79     virtual void didCancel() override;
  80
  81     void dispatchEvent(Timer<ExternalPopupMenu>*);
  82
  83     PopupMenuClient* m_popupMenuClient;
  84     RefPtrWillBeMember<LocalFrame> m_localFrame;
  85     WebViewImpl& m_webView;
  86     OwnPtr<WebMouseEvent> m_syntheticEvent;
  87     Timer<ExternalPopupMenu> m_dispatchEventTimer;
  88     // The actual implementor of the show menu.
  89     WebExternalPopupMenu* m_webExternalPopupMenu;
  90 };
  91
  92 } // namespace blink
  93
  94 #endif // ExternalPopupMenu_h