SO3WebNavigatorWidget.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) 2012 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 _SO3_PLUGIN_WEB_NAVIGATOR_H_
#define _SO3_PLUGIN_WEB_NAVIGATOR_H_
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SO3Widget.h"
#include "SO3Web/SO3EmbeddedWebNavigator.h"
#include "SO3Web/SO3EmbeddedWebNavigatorManager.h"
 
#if SO3_WEB_NAVIGATOR_BUILD == 1
 
namespace SO3
{
 
#define SO3_WEB_NAVIGATOR_WIDGET_TYPE "WebNavigator"
 
class SO3WebNavigatorWidgetListener : public SO3::EmbeddedWebNavigator::WebNavigatorListener
{
public:
protected:
private:
  SWebNavigatorWidget* targetWidget;
 
public:
  SO3WebNavigatorWidgetListener(SWebNavigatorWidget* targetWidgetInstance);
 
  virtual void OnExternalCall(SO3::EmbeddedWebNavigator::WebNavigator* sourceWebNavigator, const SO3::SScriptFunction& functionCalled);
 
  virtual void OnExternalCallStr(SO3::EmbeddedWebNavigator::WebNavigator* sourceWebNavigator, const SO3::SScriptFunction& functionCalled);
 
  virtual void OnLoadStart(SO3::EmbeddedWebNavigator::WebNavigator* sourceWebNavigator, const std::string& frameName);
 
  virtual void OnLoadEnd(SO3::EmbeddedWebNavigator::WebNavigator* sourceWebNavigator, const std::string& frameName, int httpStatusCode);
 
  virtual void OnLoadError(SO3::EmbeddedWebNavigator::WebNavigator* sourceWebNavigator, const std::string& frameName, int errorCode, const std::string& failedUrl, std::string& errorText);
 
  virtual void OnCursorChange(SO3::EmbeddedWebNavigator::WebNavigator* sourceWebNavigator, HCURSOR newCursor);
protected:
private:
};
 
class _SO3_Export SWebNavigatorWidget : public SWidget
{
public:
protected:
private:
  EmbeddedWebNavigator::WebNavigator* embeddedWebNavigator;
  SO3WebNavigatorWidgetListener* webNavigatorListener;
  HCURSOR lastCursor;
  ScolWindowHandle parentWindow;
 
public:
  SWebNavigatorWidget(SScene* targetScene, const std::string& webNavigatorName, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SViewPort* targetViewport, const unsigned int& widgetZOrder);
 
  SWebNavigatorWidget(SScene* targetScene, const std::string& webNavigatorName, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SViewPort* targetViewport);
 
  SWebNavigatorWidget(SScene* targetScene, const std::string& webNavigatorName, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SMaterial* targetMaterial, const unsigned short& targetTechnique, const unsigned short& targetPass, const unsigned short& targetTextureUnit);
 
  ~SWebNavigatorWidget();
 
  virtual void LoadURL(const std::string& url);
 
  virtual void LoadFile(const std::string& file);
 
  /*
  Loads a string of HTML.
  @note Relative URLs will be resolved using the base directory.
  */
  void LoadHTML(const std::string& html);
 
        virtual void InjectMouseMove(const int& xPos, const int& yPos, const MouseButtonId& button);
 
        virtual void InjectMouseWheel(const int& scrollX, const int& scrollY, const int& relativeScroll);
 
        virtual void InjectMouseDown(const int& xPos, const int& yPos, const MouseButtonId& button);
 
        virtual void InjectMouseUp(const int& xPos, const int& yPos, const MouseButtonId& button);
 
  virtual void InjectTouchAdd(const int& xPos, const int& yPos, const int& touchid);
 
  virtual void InjectTouchRemove(const int& touchid);
 
  virtual void InjectTouchUpdate(const int& xPos, const int& yPos, const int& vx, const int& vy, const int& touchid);
 
  virtual void InjectKeyEvent(const UINT& msg, const ScolWindowHandle& hwnd, const WPARAM& wParam, const LPARAM& lParam);
 
  virtual void InjectTextEvent(const std::string& utf8);
 
  void Update(const bool& forceUpdate);
 
  virtual void RunScriptFunction(const std::string& functionName, const std::vector<std::string>& argumentList);
 
  virtual HCURSOR GetCurrentMouseCursor();
 
  void _SetCurrentMouseCursor(const HCURSOR& newCursor);
 
  bool CanGoBack();
 
  void GoBack();
 
  bool CanGoForward();
 
  void GoForward();
 
  void Reload();
 
  void ReloadIgnoreCache();
 
  void StopLoad();
 
  void Find(const int& identifier, const std::string& searchText, const bool& forward, const bool& matchCase, const bool& findNext);
 
  void StopFinding(const bool& clearSelection);
 
  float GetZoomLevel();
 
  void SetZoomLevel(const float& zoomLevel);
 
  void ClearHistory();
 
  void ShowDevTools();
 
  void CloseDevTools();
 
  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="");
protected:
private:
  SWebNavigatorWidget();
 
  void CommonConstructorSequence();
 
  void CreateWebNavigator();
 
  void DestroyWebNavigator();
 
  virtual void SetFocusImpl(const bool& focusOnWidget);
 
  virtual void SetTransparencyImpl(const bool& enableTransparency);
 
  virtual void SetKeyboardEnableImpl(const bool& enableKeyboardOnWidget);
  
  virtual void SetMouseEnableImpl(const bool& enableMouseOnWidget);
 
  virtual void SetSizeImpl(const unsigned short& newWidth, const unsigned short& newHeight);
 
  virtual bool CheckPixelAlpha(const int& posX, const int& posY);
};
 
}
 
#endif
#endif