ApplicationWindowKey

class HPS::ApplicationWindowKey : public HPS::WindowKey 

The ApplicationWindowKey class is a smart pointer to a database object. It is a handle to an application window Visualize can draw into.

Public Functions

ApplicationWindowKey(): The default constructor creates an uninitialized ApplicationWindowKey object. The Type() function will return Type::None.

ApplicationWindowKey(ApplicationWindowKey &&in_that)

The move constructor creates a ApplicationWindowKey by transferring the underlying impl of the rvalue reference to this ApplicationWindowKey thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a ApplicationWindowKey to take the impl from.

ApplicationWindowKey(ApplicationWindowKey const &in_that)

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

Parameters: in_that – The source ApplicationWindowKey to copy.

ApplicationWindowKey(Key const &in_key)

The copy constructor creates an ApplicationWindowKey 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 application window. Otherwise the copy will fail and the resulting ApplicationWindowKey will be invalid.

Parameters: in_key – The source Key to copy.

ApplicationWindowOptionsControl GetWindowOptionsControl()

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

Returns: A control that allows querying options specific to application windows.

ApplicationWindowOptionsControl const GetWindowOptionsControl() const

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

Returns: A control that allows querying options specific to application windows.

inline virtual HPS::Type ObjectType() const

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).

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

ApplicationWindowKey &operator=(ApplicationWindowKey &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ApplicationWindowKey thereby avoiding a copy.

Parameters: in_that – An rvalue reference to an ApplicationWindowKey to take the impl from.
Returns: A reference to this ApplicationWindowKey.

bool ShowWindowOptions(ApplicationWindowOptionsKit &out_kit) const

Shows the application-window-specific options for this ApplicationWindowKey.

Parameters: out_kit – The application-window-specific options for this ApplicationWindowKey.
Returns: true if any options are set, false otherwise.

~ApplicationWindowKey()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ApplicationWindowKey