include/OffscreenGecko/browser.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is OffscreenGecko code.
 *
 * The Initial Developer of the Original Code is
 * Frank Richter <frank.richter@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef __OFFSCREENGECKO_BROWSER_H__
#define __OFFSCREENGECKO_BROWSER_H__

#include "embedding.h"

OSGK_DERIVEDTYPE(OSGK_Browser);

OSGK_EXTERN_C OSGK_API OSGK_Browser* osgk_browser_create (
  OSGK_Embedding* embedding, int width, int height);

OSGK_EXTERN_C OSGK_API void osgk_browser_navigate (OSGK_Browser* browser,
  const char* uri);

OSGK_EXTERN_C OSGK_API int osgk_browser_query_dirty (OSGK_Browser* browser);

OSGK_EXTERN_C OSGK_API const unsigned char* osgk_browser_lock_data (
  OSGK_Browser* browser, int* isDirty OSGK_DEFAULT_ARG(0));

OSGK_EXTERN_C OSGK_API void osgk_browser_unlock_data (OSGK_Browser* browser,
  const unsigned char* data);


typedef enum OSGK_MouseButton
{
  mbLeft, 
  mbRight, 
  mbMiddle
} OSGK_MouseButton;

typedef enum OSGK_MouseButtonEventType
{
  meDown,
  meUp,
  meDoubleClick
} OSGK_MouseButtonEventType;

OSGK_EXTERN_C OSGK_API void osgk_browser_event_mouse_move (
  OSGK_Browser* browser, int x, int y);

OSGK_EXTERN_C OSGK_API void osgk_browser_event_mouse_button (
  OSGK_Browser* browser, OSGK_MouseButton button, 
  OSGK_MouseButtonEventType eventType);

typedef enum OSGK_WheelAxis
{
  waVertical,
  waHorizontal
} OSGK_WheelAxis;

typedef enum OSGK_WheelDirection
{
  wdPositive,
  wdNegative,
  wdPositivePage,
  wdNegativePage
} OSGK_WheelDirection;

OSGK_EXTERN_C OSGK_API void osgk_browser_event_mouse_wheel (
  OSGK_Browser* browser, OSGK_WheelAxis axis, 
  OSGK_WheelDirection direction);


typedef enum OSGK_KeyboardEventType
{
  keDown,
  keUp,
  kePress
} OSGK_KeyboardEventType;

enum
{
  OSGKKey_First = 0x110000,

  OSGKKey_Backspace = OSGKKey_First,
  OSGKKey_Tab,
  OSGKKey_Return,
  OSGKKey_Shift,
  OSGKKey_Control,
  OSGKKey_Alt,
  OSGKKey_CapsLock,
  OSGKKey_Escape,
  OSGKKey_Space,
  OSGKKey_PageUp,
  OSGKKey_PageDown,
  OSGKKey_End,
  OSGKKey_Home,
  OSGKKey_Left,
  OSGKKey_Up,
  OSGKKey_Right,
  OSGKKey_Down,
  OSGKKey_Insert,
  OSGKKey_Delete,
  OSGKKey_F1,
  OSGKKey_F2,
  OSGKKey_F3,
  OSGKKey_F4,
  OSGKKey_F5,
  OSGKKey_F6,
  OSGKKey_F7,
  OSGKKey_F8,
  OSGKKey_F9,
  OSGKKey_F10,
  OSGKKey_F11,
  OSGKKey_F12,
  OSGKKey_NumLock,
  OSGKKey_ScrollLock,
  OSGKKey_Meta
};

OSGK_EXTERN_C OSGK_API int osgk_browser_event_key (
  OSGK_Browser* browser, unsigned int key,
  OSGK_KeyboardEventType eventType);


typedef enum OSGK_AntiAliasType
{
  aaNone,
  aaGray,
  /* Depends on whether a modification I made to gecko makes it into the source -
     see https://bugzilla.mozilla.org/show_bug.cgi?id=407531 */
  aaSubpixel
} OSGK_AntiAliasType;

OSGK_EXTERN_C OSGK_API void osgk_browser_set_antialias (
  OSGK_Browser* browser, OSGK_AntiAliasType aaType);

OSGK_EXTERN_C OSGK_API OSGK_AntiAliasType 
  osgk_browser_get_antialias (OSGK_Browser* browser);

OSGK_EXTERN_C OSGK_API void osgk_browser_focus (OSGK_Browser* browser);

OSGK_EXTERN_C OSGK_API void osgk_browser_resize (OSGK_Browser* browser,
  int width, int height);

OSGK_EXTERN_C OSGK_API int osgk_browser_set_user_data (OSGK_Browser* browser,
  unsigned int key, void* data, int overrideData OSGK_DEFAULT_ARG(0));
OSGK_EXTERN_C OSGK_API int osgk_browser_get_user_data (OSGK_Browser* browser,
  unsigned int key, void** data);

typedef enum OSGK_LoadState
{
  loadLoading,
  loadFinished
} OSGK_LoadState;

OSGK_EXTERN_C OSGK_API OSGK_LoadState osgk_browser_query_load_state (
  OSGK_Browser* browser);

OSGK_EXTERN_C OSGK_API float osgk_browser_query_load_progress (
  OSGK_Browser* browser);

OSGK_EXTERN_C OSGK_API int osgk_browser_get_preferred_dimensions (
  OSGK_Browser* browser, int* preferredWidth, int* preferredHeight,
  int maxWidth OSGK_DEFAULT_ARG(-1));

#ifdef __cplusplus
namespace OSGK
{
  struct Browser : public CXXAPI::Wrap<OSGK_Browser>
  {
    Browser (Embedding& embedding, int width, int height) : 
      WrapperType (osgk_browser_create (embedding.GetObject(),
        width, height)) { }

    explicit Browser (WrappedType* obj) : WrapperType (obj) {}
    Browser& operator=(const Browser& other)
    {
      WrapperType::operator=(other);
      return *this;
    }
    
    void Navigate (const char* uri)
    {
      osgk_browser_navigate (GetObject(), uri);
    }
    
    bool IsDirty()
    {
      return osgk_browser_query_dirty (GetObject()) != 0;
    }
    const unsigned char* LockData()
    {
      return osgk_browser_lock_data (GetObject ());
    }
    const unsigned char* LockData(bool& isDirty)
    {
      int d;
      const unsigned char* p = osgk_browser_lock_data (GetObject (), &d);
      isDirty = d != 0;
      return p;
    }
    void UnlockData (const unsigned char* data)
    {
      osgk_browser_unlock_data (GetObject (), data);
    }
    void EventMouseMove (int x, int y)
    {
      osgk_browser_event_mouse_move (GetObject(), x, y);
    }

    void EventMouseButton (OSGK_MouseButton button, 
      OSGK_MouseButtonEventType eventType)
    {
      osgk_browser_event_mouse_button (GetObject(), button, eventType);
    }

    void EventMouseWheel (OSGK_WheelAxis axis, OSGK_WheelDirection direction)
    {
      osgk_browser_event_mouse_wheel (GetObject(), axis, direction);
    }
    bool EventKey (unsigned int key, OSGK_KeyboardEventType eventType)
    {
      return osgk_browser_event_key (GetObject(), key, eventType) != 0;
    }
    void SetAntialias (OSGK_AntiAliasType aaType)
    {
      osgk_browser_set_antialias (GetObject(), aaType);
    }

    OSGK_AntiAliasType GetAntialias ()
    {
      return osgk_browser_get_antialias (GetObject());
    }

    void Focus ()
    {
      osgk_browser_focus (GetObject());
    }

    void Resize (int width, int height)
    {
      osgk_browser_resize (GetObject(), width, height);
    }

    bool SetUserData (unsigned int key, void* data, bool overrideData = false)
    {
      return osgk_browser_set_user_data (GetObject(), key, data, overrideData) != 0;
    }
    bool GetUserData (unsigned int key, void*& data)
    {
      return osgk_browser_get_user_data (GetObject(), key, &data) != 0;
    }
    OSGK_LoadState QueryLoadState ()
    {
      return osgk_browser_query_load_state (GetObject());
    }

    float QueryLoadProgress ()
    {
      return osgk_browser_query_load_progress (GetObject());
    }
    bool GetPreferredDimensions (int& preferredWidth, int& preferredHeight,
      int maxWidth = -1)
    {
      return osgk_browser_get_preferred_dimensions (GetObject(),
        &preferredWidth, &preferredHeight, maxWidth) != 0;
    }
  };
  
} // namespace OSGK
#endif

#endif // __OFFSCREENGECKO_BROWSER_H__

---