OffScreenWindowKey

class HPS.OffScreenWindowKey : public HPS.WindowKey

The OffScreenWindowKey class is a smart pointer to a database object. Offscreen windows are special types of windows that represent images that can be rendered into.

Public Functions

override void Dispose ()

HPS.OffScreenWindowOptionsControl GetWindowOptionsControl ()

Gets a control that allows querying options specific to offscreen windows.

Return

A control that allows querying options specific to offscreen windows.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

OffScreenWindowKey ()

The default constructor creates an uninitialized OffScreenWindowKey object. The Type() function will return Type.None.

OffScreenWindowKey (HPS.Key in_key)

The copy constructor creates an OffScreenWindowKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an offscreen window. Otherwise the copy will fail and the resulting OffScreenWindowKey will be invalid.

Param in_key

The source Key to copy.

OffScreenWindowKey (HPS.OffScreenWindowKey in_that)

The copy constructor creates a OffScreenWindowKey object that shares the underlying smart-pointer of the source OffScreenWindowKey.

Param in_that

The source OffScreenWindowKey to copy.

bool ShowWindowOptions (out HPS.OffScreenWindowOptionsKit out_kit)

Shows the offscreen-window-specific options for this OffScreenWindowKey.

Param out_kit

The offscreen-window-specific options for this OffScreenWindowKey.

Return

true if any options are set, false otherwise.