ultralight::Overlay Class Reference

#include <AppCore/Overlay.h>

Details

Web-content overlay.

Displays a web-page within an area of a Window.

Note

Each Overlay is essentially a View and an on-screen quad. You should create the Overlay then load content into the underlying View.

Inheritance diagram for ultralight::Overlay:

Static Public Member Functions
static RefPtr< Overlay >	Create (RefPtr< Window > window, uint32_t width, uint32_t height, int x, int y)
	Create a new Overlay.
static RefPtr< Overlay >	Create (RefPtr< Window > window, RefPtr< View > view, int x, int y)
	Create a new Overlay, wrapping an existing View.

Public Member Functions
virtual ultralight::RefPtr< ultralight::View >	view ()=0
	Get the underlying View.
virtual uint32_t	width () const =0
	Get the width (in pixels).
virtual uint32_t	height () const =0
	Get the height (in pixels).
virtual int	x () const =0
	Get the x-position (offset from the left of the Window), in pixels.
virtual int	y () const =0
	Get the y-position (offset from the top of the Window), in pixels.
virtual bool	is_hidden () const =0
	Whether or not the overlay is hidden (not drawn).
virtual void	Hide ()=0
	Hide the overlay (will no longer be drawn)
virtual void	Show ()=0
	Show the overlay.
virtual bool	has_focus () const =0
	Whether or not this overlay has keyboard focus.
virtual void	Focus ()=0
	Grant this overlay exclusive keyboard focus.
virtual void	Unfocus ()=0
	Remove keyboard focus.
virtual void	MoveTo (int x, int y)=0
	Move the overlay to a new position (in pixels).
virtual void	Resize (uint32_t width, uint32_t height)=0
	Resize the overlay (and underlying View), dimensions should be specified in pixels.
virtual bool	NeedsRepaint ()=0
	Whether or not this Overlay needs repaint (either it has moved, resized, or the internal View needs repaint).
Public Member Functions inherited from ultralight::RefCounted
virtual void	AddRef () const =0
virtual void	Release () const =0
virtual int	ref_count () const =0

Protected Member Functions
virtual	~Overlay ()
virtual void	Paint ()=0
Protected Member Functions inherited from ultralight::RefCounted
virtual	~RefCounted ()

Friends
class	OverlayManager

Constructor & Destructor Documentation

~Overlay()

virtual ultralight::Overlay::~Overlay ( )

protectedvirtual

Member Function Documentation

Create() [1/2]

static RefPtr< Overlay > ultralight::Overlay::Create ( RefPtr< Window >  window, RefPtr< View >  view, int  x, int  y  )

static

Create a new Overlay, wrapping an existing View.

Parameters

window	The window to create the Overlay in.
view	The View to wrap (will use its width and height).
x	The x-position (offset from the left of the Window), in pixels.
y	The y-position (offset from the top of the Window), in pixels.

Create() [2/2]

static RefPtr< Overlay > ultralight::Overlay::Create ( RefPtr< Window >  window, uint32_t  width, uint32_t  height, int  x, int  y  )

static

Create a new Overlay.

Parameters

window	The window to create the Overlay in.
width	The width in pixels.
height	The height in pixels.
x	The x-position (offset from the left of the Window), in pixels.
y	The y-position (offset from the top of the Window), in pixels.

Focus()

virtual void ultralight::Overlay::Focus ( )

pure virtual

Grant this overlay exclusive keyboard focus.

has_focus()

virtual bool ultralight::Overlay::has_focus ( ) const

pure virtual

Whether or not this overlay has keyboard focus.

height()

virtual uint32_t ultralight::Overlay::height ( ) const

pure virtual

Get the height (in pixels).

Hide()

virtual void ultralight::Overlay::Hide ( )

pure virtual

Hide the overlay (will no longer be drawn)

is_hidden()

virtual bool ultralight::Overlay::is_hidden ( ) const

pure virtual

Whether or not the overlay is hidden (not drawn).

MoveTo()

virtual void ultralight::Overlay::MoveTo ( int  x, int  y  )

pure virtual

Move the overlay to a new position (in pixels).

NeedsRepaint()

virtual bool ultralight::Overlay::NeedsRepaint ( )

pure virtual

Whether or not this Overlay needs repaint (either it has moved, resized, or the internal View needs repaint).

Paint()

virtual void ultralight::Overlay::Paint ( )

protectedpure virtual

Resize()

virtual void ultralight::Overlay::Resize ( uint32_t  width, uint32_t  height  )

pure virtual

Resize the overlay (and underlying View), dimensions should be specified in pixels.

Show()

virtual void ultralight::Overlay::Show ( )

pure virtual

Show the overlay.

Unfocus()

virtual void ultralight::Overlay::Unfocus ( )

pure virtual

Remove keyboard focus.

view()

virtual ultralight::RefPtr< ultralight::View > ultralight::Overlay::view ( )

pure virtual

Get the underlying View.

width()

virtual uint32_t ultralight::Overlay::width ( ) const

pure virtual

Get the width (in pixels).

x()

virtual int ultralight::Overlay::x ( ) const

pure virtual

Get the x-position (offset from the left of the Window), in pixels.

y()

virtual int ultralight::Overlay::y ( ) const

pure virtual

Get the y-position (offset from the top of the Window), in pixels.

Friends And Related Symbol Documentation

OverlayManager

friend class OverlayManager

friend

---

The documentation for this class was generated from the following file:

• AppCore/Overlay.h