#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The HPS::HighlightControl class is a smart pointer that is tied to a database object. It is used to control highlight and unhighlight operations on selection results, search results, key paths and keys. This table lists default * values for the various segment attributes accessible from HPS::HighlightControl.
|
explicit |
This constructor creates a HighlightControl object which is tied to the specified window.
in_window | The window which this HighlightControl should operate on. |
HPS::HighlightControl::HighlightControl | ( | HighlightControl const & | in_that | ) |
The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl.
in_that | The source HighlightControl to copy. |
HPS::HighlightControl::HighlightControl | ( | HighlightControl && | in_that | ) |
The move constructor creates a HighlightControl by transferring the underlying impl of the rvalue reference to this HighlightControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a HighlightControl to take the impl from. |
HighlightControl& HPS::HighlightControl::Highlight | ( | SelectionResults const & | in_items, |
HighlightOptionsKit const & | in_options | ||
) |
Highlight the specified selection results using the specified highlight options.
in_items | The selection results to highlight. If there are invalid selection items in the selection results, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HighlightControl& HPS::HighlightControl::Highlight | ( | SelectionItem const & | in_item, |
HighlightOptionsKit const & | in_options | ||
) |
Highlight the specified selection item using the specified highlight options.
in_item | The selection item to highlight. If the selection item is invalid, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HighlightControl& HPS::HighlightControl::Highlight | ( | SearchResults const & | in_items, |
HighlightOptionsKit const & | in_options | ||
) |
Highlight the specified search results using the specified highlight options.
in_items | The search results to highlight. If there are invalid keys in the selection results, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HighlightControl& HPS::HighlightControl::Highlight | ( | KeyPath const & | in_item, |
HighlightOptionsKit const & | in_options | ||
) |
Highlight the specified key path using the specified highlight options.
in_item | The key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
HighlightControl& HPS::HighlightControl::Highlight | ( | Key const & | in_item, |
HighlightOptionsKit const & | in_options | ||
) |
Highlight the specified key using the specified highlight options.
in_item | The key to highlight. If the key is invalid, an exception will be thrown. |
in_options | The options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown. |
|
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.
HighlightControl& HPS::HighlightControl::operator= | ( | HighlightControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightControl thereby avoiding a copy.
in_that | An rvalue reference to a HighlightControl to take the impl from. |
HighlightControl& HPS::HighlightControl::operator= | ( | HighlightControl const & | in_that | ) |
Share the underlying smart-pointer of the HighlightControl source.
in_that | The HighlightControl source of the assignment. |
HighlightControl& HPS::HighlightControl::Unhighlight | ( | SelectionResults const & | in_items, |
HighlightOptionsKit const & | in_options = HighlightOptionsKit() |
||
) |
Unhighlight the specified selection results by removing the specified highlight options.
in_items | The selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty HighlightOptionsKit. |
HighlightControl& HPS::HighlightControl::Unhighlight | ( | SelectionItem const & | in_item, |
HighlightOptionsKit const & | in_options = HighlightOptionsKit() |
||
) |
Unhighlight the specified selection item by removing the specified highlight options.
in_item | The selection item to unhighlight. If the selection item is invalid, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty HighlightOptionsKit. |
HighlightControl& HPS::HighlightControl::Unhighlight | ( | SearchResults const & | in_items, |
HighlightOptionsKit const & | in_options = HighlightOptionsKit() |
||
) |
Unhighlight the specified search results by removing the specified highlight options.
in_items | The search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty HighlightOptionsKit. |
HighlightControl& HPS::HighlightControl::Unhighlight | ( | KeyPath const & | in_item, |
HighlightOptionsKit const & | in_options = HighlightOptionsKit() |
||
) |
Unhighlight the specified key path by removing the specified highlight options.
in_item | The key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown. |
in_options | The highlight options to be removed. Defaults to an empty HighlightOptionsKit. |
HighlightControl& HPS::HighlightControl::Unhighlight | ( | Key const & | in_item, |
HighlightOptionsKit const & | in_options = HighlightOptionsKit() |
||
) |
Unhighlight the specified key by removing the specified highlight options.
in_item | The key to unhighlight. If the key is invalid, an exception will be thrown.. |
in_options | The highlight options to be removed. Defaults to an empty HighlightOptionsKit. |
HighlightControl& HPS::HighlightControl::Unhighlight | ( | HighlightOptionsKit const & | in_options | ) |
Unhighlight geometry which was highlighted with the specified HighlightOptionsKit.
in_options | The highlight options to be removed. |
HighlightControl& HPS::HighlightControl::UnhighlightEverything | ( | ) |
Unhighlight everything in the window associated with this HighlightControl.