#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::UpdateOptionsControl |
![]() | |
static const HPS::Type | staticType = HPS::Type::Control |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting.
Default values for the various fields of HPS::UpdateOptionsControl can be found here.
Constructor & Destructor Documentation
◆ UpdateOptionsControl() [1/3]
|
explicit |
This constructor creates a UpdateOptionsControl object which is tied to the specified window.
- Parameters
-
in_window The window which this UpdateOptionsControl should operate on.
◆ UpdateOptionsControl() [2/3]
HPS::UpdateOptionsControl::UpdateOptionsControl | ( | UpdateOptionsControl const & | in_that | ) |
The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.
- Parameters
-
in_that The source UpdateOptionsControl to copy.
◆ UpdateOptionsControl() [3/3]
HPS::UpdateOptionsControl::UpdateOptionsControl | ( | UpdateOptionsControl && | in_that | ) |
The move constructor creates a UpdateOptionsControl by transferring the underlying impl of the rvalue reference to this UpdateOptionsControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a UpdateOptionsControl to take the impl from.
Member Function Documentation
◆ ObjectType()
|
inlinevirtual |
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.
Reimplemented from HPS::Control.
◆ operator=() [1/2]
UpdateOptionsControl& HPS::UpdateOptionsControl::operator= | ( | UpdateOptionsControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this UpdateOptionsControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a UpdateOptionsControl to take the impl from.
- Returns
- A reference to this UpdateOptionsControl.
◆ operator=() [2/2]
UpdateOptionsControl& HPS::UpdateOptionsControl::operator= | ( | UpdateOptionsControl const & | in_that | ) |
Share the underlying smart-pointer of the UpdateOptionsControl source.
- Parameters
-
in_that The UpdateOptionsControl source of the assignment.
- Returns
- A reference to this UpdateOptionsControl.
◆ SetTimeLimit()
UpdateOptionsControl& HPS::UpdateOptionsControl::SetTimeLimit | ( | HPS::Time | in_time_limit | ) |
Sets the time limit of this UpdateOptionsControl.
- Parameters
-
in_time_limit The time limit for this UpdateOptionsControl update.
- Returns
- A reference to this UpdateOptionsControl.
◆ SetUpdateType()
UpdateOptionsControl& HPS::UpdateOptionsControl::SetUpdateType | ( | HPS::Window::UpdateType | in_type | ) |
Sets the type of update of this UpdateOptionsControl.
- Parameters
-
in_type The type of update that this UpdateOptionsControl will perform.
- Returns
- A reference to this UpdateOptionsControl.
◆ ShowTimeLimit()
bool HPS::UpdateOptionsControl::ShowTimeLimit | ( | HPS::Time & | out_time_limit | ) | const |
Shows the time limit from this UpdateOptionsControl.
- Parameters
-
out_proximity The selection proximity.
- Returns
- true if the time limit is valid, false otherwise.
◆ ShowUpdateType()
bool HPS::UpdateOptionsControl::ShowUpdateType | ( | HPS::Window::UpdateType & | out_type | ) | const |
Shows the type of control from this UpdateOptionsControl.
- Parameters
-
out_type The type of update.
- Returns
- true if the type is valid, false otherwise.
◆ Type()
|
inlinevirtual |
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
◆ UnsetEverything()
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetEverything | ( | ) |
Removes all settings from this UpdateOptionsControl. If the control is attached to a WindowKey this function restores the default settings of this control as specified by UpdateOptionsKit::GetDefault().
- Returns
- A reference to this UpdateOptionsControl.
◆ UnsetTimeLimit()
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetTimeLimit | ( | ) |
Removes the time limit of this UpdateOptionsControl. If the control is attached to a WindowKey this function restores the default value of this setting as specified by UpdateOptionsKit::GetDefault().
- Returns
- A reference to this UpdateOptionsControl.
◆ UnsetUpdateType()
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetUpdateType | ( | ) |
Removes the type of control for this update Control. If the control is attached to a WindowKey this function restores the default value of this setting as specified by UpdateOptionsKit::GetDefault().
- Returns
- A reference to this UpdateOptionsControl.
The documentation for this class was generated from the following file:
- include/hps.h