
Public Member Functions | |
void | Assign (HPS.UpdateNotifier in_that) |
Share the underlying smart-pointer of the UpdateNotifier source. More... | |
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(). More... | |
override void | Dispose () |
override HPS.Type | ObjectType () |
HPS.Window.UpdateStatus | Status () |
Returns the HPS.Window.UpdateStatus for the Update represented by this UpdateNotifier. More... | |
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. More... | |
HPS.UpdateNotifier | Wait () |
Wait for this Notifier to complete its Update. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The move constructor creates an UpdateNotifier by transferring the underlying impl of the rvalue reference to this UpdateNotifier thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an UpdateNotifier to take the impl from.
Member Function Documentation
|
inline |
Share the underlying smart-pointer of the UpdateNotifier source.
- Parameters
-
in_that The UpdateNotifier source of the assignment.
|
inline |
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().
- Returns
- A reference to this UpdateNotifier.
|
inline |
Returns the HPS.Window.UpdateStatus for the Update represented by this UpdateNotifier.
|
inline |
Wait for this Notifier to complete its Update.
- Returns
- A reference to this UpdateNotifier.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.UpdateNotifier.cs