Command: embed

Syntax

embed <string>

Description

Declares an external container into which a window can subsequently be embedded. embed can also redefine the details of an external container.

Parameters

• <string>
  A name to be used as a reference to the external container.

Switches

• -ew=<num>
  Declare the container to be a window provided by an Internet browser. <num> should be either:

• an X window id (Unix)

• a Windows HWND (Windows)

• -ole=<num>
  Declare the container as one provided by an OLE client. <num> is a session id which the OLE client can obtain by querying the GetId member of the Xmarc (formerly Formida) Service Object invoked by the OLE client. This is available only on Windows sessions.

Notes

The container name can be passed to a window create command, (for example wgraphic, wdisplay, etc.) via the -emb switch. The window contents will then be embedded into the external container. When an external container window becomes unavailable, for example when paged out in a browser session, the unembed command is used to notify the Fire window contained within it. The Fire window then becomes temporarily invisible, until reinstated by another embed command.

Attempts to embed a window into a Fire window canvas in the same session does not work and will produce undesired effects.

Examples

Declare an OLE container.

embed "olewin", -ole=2
wgraphic -emb="olewin"

Declare a browser container

embed "netscape_win",-ew=0x40000c
wdisplay myfile.jpg,-emb="netscape_win"

See Also