SO3EmbeddedWebNavigator.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OpenSpace3D
For the latest info, see http://www.openspace3d.com
 
Copyright (c) 2011 I-maginer
 
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
 
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt
-----------------------------------------------------------------------------
*/
 
#ifndef _SCOL_EMBEDDED_WEB_NAVIGATOR_
#define _SCOL_EMBEDDED_WEB_NAVIGATOR_
 
#include "SO3EmbeddedWebNavigatorClient.h"
#if SO3_WEB_NAVIGATOR_BUILD == 1
#include "include/cef_client.h"
 
namespace SO3
{
  namespace EmbeddedWebNavigator
  {
    static bool IsKeyDown(WPARAM wparam)
    {
      return (GetKeyState((int)wparam) & 0x8000) != 0;
    }
 
    static int GetCefKeyboardModifiers(WPARAM wparam, LPARAM lparam)
    {
      int modifiers = 0;
      if (IsKeyDown(VK_SHIFT))
        modifiers |= EVENTFLAG_SHIFT_DOWN;
      if (IsKeyDown(VK_CONTROL))
        modifiers |= EVENTFLAG_CONTROL_DOWN;
      if (IsKeyDown(VK_MENU))
        modifiers |= EVENTFLAG_ALT_DOWN;
 
      // Low bit set from GetKeyState indicates "toggled".
      if (::GetKeyState(VK_NUMLOCK) & 1)
        modifiers |= EVENTFLAG_NUM_LOCK_ON;
      if (::GetKeyState(VK_CAPITAL) & 1)
        modifiers |= EVENTFLAG_CAPS_LOCK_ON;
 
      switch (wparam) {
      case VK_RETURN:
        if ((lparam >> 16) & KF_EXTENDED)
          modifiers |= EVENTFLAG_IS_KEY_PAD;
        break;
      case VK_INSERT:
      case VK_DELETE:
      case VK_HOME:
      case VK_END:
      case VK_PRIOR:
      case VK_NEXT:
      case VK_UP:
      case VK_DOWN:
      case VK_LEFT:
      case VK_RIGHT:
        if (!((lparam >> 16) & KF_EXTENDED))
          modifiers |= EVENTFLAG_IS_KEY_PAD;
        break;
      case VK_NUMLOCK:
      case VK_NUMPAD0:
      case VK_NUMPAD1:
      case VK_NUMPAD2:
      case VK_NUMPAD3:
      case VK_NUMPAD4:
      case VK_NUMPAD5:
      case VK_NUMPAD6:
      case VK_NUMPAD7:
      case VK_NUMPAD8:
      case VK_NUMPAD9:
      case VK_DIVIDE:
      case VK_MULTIPLY:
      case VK_SUBTRACT:
      case VK_ADD:
      case VK_DECIMAL:
      case VK_CLEAR:
        modifiers |= EVENTFLAG_IS_KEY_PAD;
        break;
      case VK_SHIFT:
        if (IsKeyDown(VK_LSHIFT))
          modifiers |= EVENTFLAG_IS_LEFT;
        else if (IsKeyDown(VK_RSHIFT))
          modifiers |= EVENTFLAG_IS_RIGHT;
        break;
      case VK_CONTROL:
        if (IsKeyDown(VK_LCONTROL))
          modifiers |= EVENTFLAG_IS_LEFT;
        else if (IsKeyDown(VK_RCONTROL))
          modifiers |= EVENTFLAG_IS_RIGHT;
        break;
      case VK_MENU:
        if (IsKeyDown(VK_LMENU))
          modifiers |= EVENTFLAG_IS_LEFT;
        else if (IsKeyDown(VK_RMENU))
          modifiers |= EVENTFLAG_IS_RIGHT;
        break;
      case VK_LWIN:
        modifiers |= EVENTFLAG_IS_LEFT;
        break;
      case VK_RWIN:
        modifiers |= EVENTFLAG_IS_RIGHT;
        break;
      }
      return modifiers;
    }
 
    class WebNavigator
    {
    public:
    protected:
    private:
      const unsigned long uniqueId;
      const ScolWindowHandle scolMainWindowHandle;
      const ScolWindowHandle parentWindowHandle;
      const bool mOffscreen;
      bool mTransparency;
      CefRefPtr<WebNavigatorClient> webNavigatorClient;
      std::pair<int, int> actualSize;
      std::pair<int, int> actualPosition;
      HANDLE synchroEventCanGoBack;
      HANDLE synchroEventCanGoForward;
      HANDLE synchroEventGetZoomLevel;
      HANDLE synchroEventGetSource;
      HANDLE synchroEventGetURL;
      HANDLE synchroEventGetText;
      WebNavigatorListener* listener; // Only one listener allowed
 
    public:
      WebNavigator(const unsigned long navigatorUniqueId, const ScolWindowHandle& scolMainWindow, const ScolWindowHandle& parentWindowHandleInstance, int xPosition, int yPosition, int width, int height, std::string url);
 
      WebNavigator(const unsigned long navigatorUniqueId, const ScolWindowHandle& scolMainWindow, const ScolWindowHandle& parentWindowHandleInstance, int width, int height, std::string url, bool transparency);
 
      virtual ~WebNavigator();
 
      unsigned long GetUniqueId();
 
      ScolWindowHandle GetParentWindowHandle();
 
      CefRefPtr<WebNavigatorClient>& GetWebNavigatorClient();
 
      void LoadURL(const std::string& url, const std::string& frameName = "");
 
      void LoadFile(const std::string& file, const std::string& frameName = "");
 
      /*
      Loads a string of HTML.
      @param url The html text to load
      @param frameName The target frame, main frame will be used if empty.
      @note     Relative URLs will be resolved using the base directory.
      */
      void LoadHTML(const std::string& html, const std::string& frameName = "");
 
      std::string GetURL(const std::string& frameName = "");
 
      void Undo(const std::string& frameName = "");
 
      void Redo(const std::string& frameName = "");
 
      void Cut(const std::string& frameName = "");
 
      void Copy(const std::string& frameName = "");
 
      void Paste(const std::string& frameName = "");
 
      void Delete(const std::string& frameName = "");
 
      void SelectAll(const std::string& frameName = "");
 
      void Print(const std::string& frameName = "");
 
      void ViewSource(const std::string& frameName = "");
 
      std::string GetSource(const std::string& frameName = "");
 
      std::string GetText(const std::string& frameName = "");
 
      void ExecuteJavaScript(const std::string& jsCode, const std::string& scriptUrl, int startLine, const std::string& frameName = "");
 
      bool CanGoBack();
 
      void GoBack();
 
      bool CanGoForward();
 
      void GoForward();
 
      void Reload();
 
      void ReloadIgnoreCache();
 
      void StopLoad();
 
      void Find(int identifier, const CefString& searchText, bool forward, bool matchCase, bool findNext);
 
      void StopFinding(bool clearSelection);
 
      double GetZoomLevel();
 
      void SetZoomLevel(double zoomLevel);
 
      void ClearHistory();
 
      void ShowDevTools();
 
      void CloseDevTools();
 
      std::pair<int, int> GetSize();
 
      void SetSize(std::pair<int, int> newSize);
 
      std::pair<int, int> GetPosition();
 
      void SetPosition(std::pair<int, int> newPosition);
 
      bool IsOffscreen() const;
 
      void InjectKeyMsg(int msg, LPARAM lparam, WPARAM wparam);
 
      void InjectKey(int scanCode, int keydata, bool down);
 
      void InjectChar(int scanCode, int keydata);
 
      void InjectMouseClick(int x, int y, int buttonType, bool mouseUp, int clickCount);
 
      void InjectMouseMove(int x, int y, bool mouseLeave);
 
      void InjectMouseWheel(int x, int y, int delta);
 
      void InjectFocus(bool setFocus);
 
      //void InjectCaptureLostEvent();
 
      void SetListener(WebNavigatorListener* newListener);
 
      WebNavigatorListener* GetListener();
    protected:
      // the browser reference
      CefRefPtr<CefBrowser> browser;
 
    private:
      WebNavigator();
 
      void CommonConstructorSequence(std::pair<int, int> newWebNavigatorPosition, std::pair<int, int> newWebNavigatorSize, std::string url);
 
      void ApplyPositionAndSize();
 
      CefBrowserHost::MouseButtonType ConvertMouseButton(int scolButton);
    };
  }
}
 
#endif
#endif