UpdateNotifier

class HPS.UpdateNotifier : public HPS.Object 

The UpdateNotifier class is a smart pointer that is associated with a window update. It is a special type of control that is used for synchronizing with a window update status.

Public Functions

void Assign (HPS.UpdateNotifier in_that)

Share the underlying smart-pointer of the UpdateNotifier source.

Param in_that: The UpdateNotifier source of the assignment.

HPS.UpdateNotifier Cancel ()

Requests to cancel this Notifier’s Update operation. The cancel operation returns without waiting for the Update to complete. To ensure that the Update is complete, you must call Wait().

Return: A reference to this UpdateNotifier.

override void Dispose ()

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.

HPS.Window.UpdateStatus Status (): Returns the HPS.Window.UpdateStatus for the Update represented by this UpdateNotifier.

UpdateNotifier ()

UpdateNotifier (HPS.UpdateNotifier in_that)

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

Param in_that: An rvalue reference to an UpdateNotifier to take the impl from.

HPS.UpdateNotifier Wait ()

Wait for this Notifier to complete its Update.

Return: A reference to this UpdateNotifier.