OSGK::Embedding Struct Reference

OffscreenGecko embedding object, the 'mother' of all OffscreenGecko objects. More...

#include <OffscreenGecko/embedding.h>

Inheritance diagram for OSGK::Embedding:

List of all members.

Public Member Functions
	Embedding (WrappedType *obj)
	Embedding (EmbeddingOptions &opt, OSGK_GeckoResult &result)
	Create a new embedding object.
	Embedding (EmbeddingOptions &opt)
	Create a new embedding object.
	Embedding (OSGK_GeckoResult &result)
	Create a new embedding object.
	Embedding ()
	Create a new embedding object.
ComponentMgr	GetComponentMgr ()
	Get Gecko component manager wrapper.
nsIComponentManager *	GetGeckoComponentManager ()
	Get interface for actual Gecko component manager.
nsIComponentRegistrar *	GetGeckoComponentRegistrar ()
	Get interface for actual Gecko component registrar.
GeckoMem	GetGeckoMem ()
	Get Gecko memory allocator object.
nsIServiceManager *	GetGeckoServiceManager ()
	Get interface for actual Gecko service manager.
Embedding &	operator= (const Embedding &other)
bool	RegisterJSGlobal (const char *name, const char *contractID, unsigned int flags, String &previous, OSGK_GeckoResult &geckoResult)
	Register a global object for JavaScript scripting.
bool	RegisterJSGlobal (const char *name, const char *contractID, unsigned int flags, OSGK_GeckoResult &geckoResult)
	Register a global object for JavaScript scripting.
bool	RegisterJSGlobal (const char *name, const char *contractID, unsigned int flags, String &previous)
	Register a global object for JavaScript scripting.
bool	RegisterJSGlobal (const char *name, const char *contractID, unsigned int flags)
	Register a global object for JavaScript scripting.
Focus helpers
void	ClearFocus ()
	Clear focus so no browser is focused.
bool	GetAutoFocus ()
	Get whether auto-focus is enabled.
void	SetAutoFocus (bool autoFocus)
	Enable/disables "auto-focus".

---

Detailed Description

OffscreenGecko embedding object, the 'mother' of all OffscreenGecko objects.

See also:

Dealing with OffscreenGecko objects (C++)

---

Constructor & Destructor Documentation

OSGK::Embedding::Embedding

(

)

[inline]

Create a new embedding object.

OSGK::Embedding::Embedding

(

OSGK_GeckoResult &

result

)

[inline]

Create a new embedding object.

Parameters:

result

Returns the result code from Gecko. Can be 0.

OSGK::Embedding::Embedding

(

EmbeddingOptions &

opt

)

[inline]

Create a new embedding object.

Parameters:

opt

A set of options for the embedding to be created.

OSGK::Embedding::Embedding	(	EmbeddingOptions &	opt,
		OSGK_GeckoResult &	result
	)			[inline]

Create a new embedding object.

Parameters:

	opt	A set of options for the embedding to be created.
	result	Returns the result code from Gecko. Can be 0.

OSGK::Embedding::Embedding

(

WrappedType *

obj

)

[inline, explicit]

---

Member Function Documentation

void OSGK::Embedding::ClearFocus

(

)

[inline]

Clear focus so no browser is focused.

Proper clearing of focus is needed for some things such as e.g. preventing caret displaying.

bool OSGK::Embedding::GetAutoFocus

(

)

[inline]

Get whether auto-focus is enabled.

Returns:

Whether auto-focus is enabled or disabled.

See also:

SetAutoFocus

ComponentMgr OSGK::Embedding::GetComponentMgr

(

)

[inline]

Get Gecko component manager wrapper.

nsIComponentManager* OSGK::Embedding::GetGeckoComponentManager

(

)

[inline]

Get interface for actual Gecko component manager.

Returns:

Interface of Gecko component manager.

Remarks:

The returned interface has no reference implicitly added.

nsIComponentRegistrar* OSGK::Embedding::GetGeckoComponentRegistrar

(

)

[inline]

Get interface for actual Gecko component registrar.

Returns:

Interface of Gecko component registrar.

Remarks:

The returned interface has no reference implicitly added.

GeckoMem OSGK::Embedding::GetGeckoMem

(

)

[inline]

Get Gecko memory allocator object.

nsIServiceManager* OSGK::Embedding::GetGeckoServiceManager

(

)

[inline]

Get interface for actual Gecko service manager.

Returns:

Interface of Gecko service manager.

Remarks:

The returned interface has no reference implicitly added.

Embedding& OSGK::Embedding::operator=

(

const Embedding &

other

)

[inline]

bool OSGK::Embedding::RegisterJSGlobal	(	const char *	name,
		const char *	contractID,
		unsigned int	flags,
		String &	previous,
		OSGK_GeckoResult &	geckoResult
	)			[inline]

Register a global object for JavaScript scripting.

Parameters:

	name	Identifier of the global object.
	contractID	Contract ID used to instantiate the object.
	flags	Registration flags.
	previous	Receives a previously registered contract ID for the given identifier.
	geckoResult	Receives the Gecko result code for the registration.

Returns:

Whether the registration was successful (true) or not (false).

See also:

jsgPrivileged

bool OSGK::Embedding::RegisterJSGlobal	(	const char *	name,
		const char *	contractID,
		unsigned int	flags,
		OSGK_GeckoResult &	geckoResult
	)			[inline]

Register a global object for JavaScript scripting.

Parameters:

	name	Identifier of the global object.
	contractID	Contract ID used to instantiate the object.
	flags	Registration flags.
	geckoResult	Receives the Gecko result code for the registration.

Returns:

Whether the registration was successful (true) or not (false).

See also:

jsgPrivileged

bool OSGK::Embedding::RegisterJSGlobal	(	const char *	name,
		const char *	contractID,
		unsigned int	flags,
		String &	previous
	)			[inline]

Register a global object for JavaScript scripting.

Parameters:

	name	Identifier of the global object.
	contractID	Contract ID used to instantiate the object.
	flags	Registration flags.
	previous	Receives a previously registered contract ID for the given identifier.

Returns:

Whether the registration was successful (true) or not (false).

See also:

jsgPrivileged

bool OSGK::Embedding::RegisterJSGlobal	(	const char *	name,
		const char *	contractID,
		unsigned int	flags
	)			[inline]

Register a global object for JavaScript scripting.

Parameters:

	name	Identifier of the global object.
	contractID	Contract ID used to instantiate the object.
	flags	Registration flags.

Returns:

Whether the registration was successful (true) or not (false).

See also:

jsgPrivileged

void OSGK::Embedding::SetAutoFocus

(

bool

autoFocus

)

[inline]

Enable/disables "auto-focus".

Auto-focus means that a browser object will get focus as soon as any event is sent to it. Proper focus handling is needed for some things such as e.g. caret handling; automatically giving the focus to a browser object receiving an event is usually a sufficient strategy to prevent oddities arising from wrong or lacking focus handling without burdening you, the user, too much. Auto-focus is by default on.

Parameters:

autoFocus

Whether to enable or disable the auto-focus feature.

---

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

• include/OffscreenGecko/embedding.h

---