/omnis-weblib

OMNIS Studio 4.3.1 Wrapper for Awesomium

Primary LanguageC++MIT LicenseMIT

Awesomium running inside O$ 4.3.X

Introduction

The following project is a Tech-Demo demonstrating the usage of Awesomium as an Omnis Studio External to display HTML5 content and to invoke Omnis Studio code from JavaScript and vice versa.

Awesomium is a commercial product for commercial apps, which exposes Chromium through an easy to use C++ API.

As it is currently unclear if the source/header/bin files from Omnis Studio and/or Awesomium can freely be distributed, we removed them from the initial release.

Any feedback regarding mistakes, possible errors and improvements is welcome.

To experience the Tech-Demo download the repo and follow the instructions.

Requirements

  • Win 7
  • O$ 4.3.X Non-Unicode
  • Omnis Externals SDK for O$ 4.3.1
  • Awesomium 1.7.X SDK with C++ examples
  • Visual Studio C++ 2008 (Express)

Installation

  • Install Awesomium and copy the following files into the specified project directory:

    • AWESOMIUM\build\bin to deploy\bin\ext\web\browser\system
    • AWESOMIUM\build\bin\awesomium.dll to deploy\bin\xcomp
    • AWESOMIUM\build\lib\awesomium.lib to include\lib
    • AWESOMIUM\include\Awesomium to include\awesomium
    • C:\Users\Public\Documents\Awesomium SDK Samples\1.7.4.X\Awesomium\BuildSamples\common\js_delegate.h to src\js_delegate.h#
    • C:\Users\Public\Documents\Awesomium SDK Samples\1.7.4.X\Awesomium\BuildSamples\common\method_dispatcher.h to src\method_dispatcher.h

  • Install the Omnis External SDK and copy the following files into the specified project directory:

    • OMNISDK\LIBS\omnis.lib to include\lib
    • OMNISDK\COMPLIB to include\omnis

  • Copy the contents of deploy\bin\xcomp into OMNIS431INSTALLDIR\xcomp

  • Modify the files resources\testdebug.bat and testtrelease.bat to match your local installation

  • Start Visual Studio 2008 C++ and open the proj\webLib.vcproj file

Building the external

  • Build the C++ Project inside Visual Studio and make sure no errors occur during the build process
  • After a successful build run the C++ program in Debug Mode
  • When asked for an executable, select your omnis.exe and the path to you're lbs\demo.lbs from this project as an commandline parameter
  • When the lbs\demo.lbs is launched for the first time a modification inside the StartupTask is necessary. The variable iBasePath has to match the path of the root folder of this project

Samples

The demo.lbs contains the following examples:

  • Websites

    • html5test.com
    • google.com
    • media.tojicode.com/q3bsp/ (WebGL Demo)

Websites

  • Event Demo
    • Demonstrates how to read properties in JavaScript from Omnis Studio and how to use these inside JavaScript
    • Shows how to send events from JavaScript to Omnis Studio (show Omnis OK message, Close current window from JavaScript)

Event

  • Ace9 Code Editor inside Omnis Studio
    • Demonstrates how to wrap a HTML component and how a two-way interaction is possible (setData & getData)

CodeEditor

  • Download
    • Download of a pdf File with a callback in Omnis Studio to return the path, where the file should be saved to.

Notes

  • Lacks documentation
  • Ugly C++ char conversion
  • Windows only
  • Every instance of the component creates its own process, which could be changed so that they every WebView is a child of one master WebView, which would save cpu & memory
  • It should be possible to us the JsClient inside Omnis and communicate between Omnis Fat-Client and Omnis JsClient

Thanks

License

The MIT License (MIT)

Copyright (c) 2014 DATAX AG

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.