View.h

Go to the documentation of this file.

#pragma once
#include <JavaScriptCore/JavaScript.h>
#include <Ultralight/Defines.h>
#include <Ultralight/RefPtr.h>
#include <Ultralight/KeyEvent.h>
#include <Ultralight/MouseEvent.h>
#include <Ultralight/ScrollEvent.h>
#include <Ultralight/RenderTarget.h>
#include <Ultralight/Bitmap.h>
#include <Ultralight/Listener.h>

namespace ultralight {

class UExport View : public RefCounted {
public:
  virtual String url() = 0;

  virtual String title() = 0;

  virtual bool is_loading() = 0;

  virtual RenderTarget render_target() = 0;

  virtual bool is_bitmap_dirty() = 0;

  // @note  Only valid when using the default, offscreen GPUDriver.
  virtual RefPtr<Bitmap> bitmap() = 0;

  virtual void LoadHTML(const String& html) = 0;

  virtual void LoadURL(const String& url) = 0;

  virtual void Resize(uint32_t width, uint32_t height) = 0;

  virtual JSContextRef js_context() = 0;

  virtual JSValueRef EvaluateScript(const String& script) = 0;

  virtual bool CanGoBack() = 0;

  virtual bool CanGoForward() = 0;

  virtual void GoBack() = 0;

  virtual void GoForward() = 0;

  virtual void GoToHistoryOffset(int offset) = 0;

  virtual void Reload() = 0;

  virtual void Stop() = 0;
  
  virtual void FireKeyEvent(const KeyEvent& evt) = 0;

  virtual void FireMouseEvent(const MouseEvent& evt) = 0;

  virtual void FireScrollEvent(const ScrollEvent& evt) = 0;

  virtual void set_view_listener(ViewListener* listener) = 0;
  
  virtual ViewListener* view_listener() const = 0;

  virtual void set_load_listener(LoadListener* listener) = 0;

  virtual LoadListener* load_listener() const = 0;

  virtual void set_needs_paint(bool needs_paint) = 0;

  virtual bool needs_paint() const = 0;

protected:
  virtual ~View();
};

}  // namespace ultralight