#include <hps.h>
Public Member Functions | |
HPS::Type | ObjectType () const |
UpdateOptionsControl & | operator= (UpdateOptionsControl &&in_that) |
UpdateOptionsControl & | operator= (UpdateOptionsControl const &in_that) |
UpdateOptionsControl & | SetTimeLimit (HPS::Time in_time_limit) |
UpdateOptionsControl & | SetUpdateType (HPS::Window::UpdateType in_type) |
bool | ShowTimeLimit (HPS::Time &out_time_limit) const |
bool | ShowUpdateType (HPS::Window::UpdateType &out_type) const |
UpdateOptionsControl & | UnsetEverything () |
UpdateOptionsControl & | UnsetTimeLimit () |
UpdateOptionsControl & | UnsetUpdateType () |
UpdateOptionsControl (WindowKey const &in_window) | |
UpdateOptionsControl (UpdateOptionsControl const &in_that) | |
UpdateOptionsControl (UpdateOptionsControl &&in_that) | |
![]() | |
Control (Control const &in_that)=default | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
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.
|
explicit |
This constructor creates a UpdateOptionsControl object which is tied to the specified window.
in_window | The window which this UpdateOptionsControl should operate on. |
HPS::UpdateOptionsControl::UpdateOptionsControl | ( | UpdateOptionsControl const & | in_that | ) |
The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.
in_that | The source UpdateOptionsControl to copy. |
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.
in_that | An rvalue reference to a UpdateOptionsControl to take the impl from. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Control.
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.
in_that | An rvalue reference to a UpdateOptionsControl to take the impl from. |
UpdateOptionsControl& HPS::UpdateOptionsControl::operator= | ( | UpdateOptionsControl const & | in_that | ) |
Share the underlying smart-pointer of the UpdateOptionsControl source.
in_that | The UpdateOptionsControl source of the assignment. |
UpdateOptionsControl& HPS::UpdateOptionsControl::SetTimeLimit | ( | HPS::Time | in_time_limit | ) |
Sets the time limit of this UpdateOptionsControl.
in_time_limit | The time limit for this UpdateOptionsControl update. |
UpdateOptionsControl& HPS::UpdateOptionsControl::SetUpdateType | ( | HPS::Window::UpdateType | in_type | ) |
Sets the type of update of this UpdateOptionsControl.
in_type | The type of update that this UpdateOptionsControl will perform. |
bool HPS::UpdateOptionsControl::ShowTimeLimit | ( | HPS::Time & | out_time_limit | ) | const |
Shows the time limit from this UpdateOptionsControl.
out_proximity | The selection proximity. |
bool HPS::UpdateOptionsControl::ShowUpdateType | ( | HPS::Window::UpdateType & | out_type | ) | const |
Shows the type of control from this UpdateOptionsControl.
out_type | The type of update. |
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetEverything | ( | ) |
Removes all settings from this UpdateOptionsControl.
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetTimeLimit | ( | ) |
Removes the time limit of this UpdateOptionsControl.
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetUpdateType | ( | ) |
Removes the type of control for this update Control.