#include <hps.h>

Static Public Member Functions | |
static HighlightOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The HighlightOptionsKit class is a user space object. It is used to hold settings needed when performing a highlight or unhighlight. HPS::HighlightOptionsKit::GetDefault() will return a highlight options kit with values found in this table.
Constructor & Destructor Documentation
HPS::HighlightOptionsKit::HighlightOptionsKit | ( | ) |
The default constructor creates an empty HighlightOptionsKit object.
HPS::HighlightOptionsKit::HighlightOptionsKit | ( | char const * | in_style_name | ) |
This constructor creates a HighlightOptionsKit object with the specified style name set on it.
- Parameters
-
in_style_name The style name to set on this HighlightOptionsKit.
HPS::HighlightOptionsKit::HighlightOptionsKit | ( | char const * | in_style_name, |
char const * | in_secondary_style_name | ||
) |
This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it.
- Parameters
-
in_style_name The style name to set on this HighlightOptionsKit. in_secondary_style_name The style name to set on this HighlightOptionsKit.
HPS::HighlightOptionsKit::HighlightOptionsKit | ( | HighlightOptionsKit const & | in_kit | ) |
The copy constructor creates a new HighlightOptionsKit object that contains the same settings as the source HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to copy.
HPS::HighlightOptionsKit::HighlightOptionsKit | ( | HighlightOptionsKit && | in_that | ) |
The move constructor creates a HighlightOptionsKit by transferring the underlying impl of the rvalue reference to this HighlightOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a HighlightOptionsKit to take the impl from.
Member Function Documentation
|
virtual |
Indicates whether this HighlightOptionsKit has any values set on it.
- Returns
- true if no values are set on this HighlightOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::HighlightOptionsKit::Equals | ( | HighlightOptionsKit const & | in_kit | ) | const |
Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to compare to this HighlightOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
Creates a HighlightOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A HighlightOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
bool HPS::HighlightOptionsKit::operator!= | ( | HighlightOptionsKit const & | in_kit | ) | const |
Check if the source HighlightOptionsKit is not equivalent to this HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to compare to this HighlightOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
HighlightOptionsKit& HPS::HighlightOptionsKit::operator= | ( | HighlightOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a HighlightOptionsKit to take the impl from.
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::operator= | ( | HighlightOptionsKit const & | in_kit | ) |
Copies the source HighlightOptionsKit into this HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to copy.
- Returns
- A reference to this HighlightOptionsKit.
bool HPS::HighlightOptionsKit::operator== | ( | HighlightOptionsKit const & | in_kit | ) | const |
Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to compare to this HighlightOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::HighlightOptionsKit::Set | ( | HighlightOptionsKit const & | in_kit | ) |
Copies the source HighlightOptionsKit into this HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to copy.
HighlightOptionsKit& HPS::HighlightOptionsKit::SetNotification | ( | bool | in_state | ) |
Whether to inject a notification event after highlighting (or unhighlighting).
- Parameters
-
in_state Whether to inject a notification event after highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
- See also
- Notification default value
HighlightOptionsKit& HPS::HighlightOptionsKit::SetOverlay | ( | Drawing::Overlay | in_overlay | ) |
Allows highlighting to take place in a segment without triggering a full-screen redraw. If any type of overlay is used, transparency in the highlighted object(s) will be ignored.
- Note
- If in_overlay is specified as Drawing::Overlay::None, Drawing::Overlay::InPlace will be used instead
- Parameters
-
in_overlay The type of overlay, if any, to be used.
- Returns
- A reference to this object.
- See also
- Overlay default value
HighlightOptionsKit& HPS::HighlightOptionsKit::SetSecondaryStyleName | ( | char const * | in_style_name | ) |
Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).
- Parameters
-
in_style_name UTF8-encoded style name.
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::SetStyleName | ( | char const * | in_style_name | ) |
Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting).
- Parameters
-
in_style_name UTF8-encoded style name.
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::SetSubentityHighlighting | ( | bool | in_enable | ) |
Sets whether subentity highlighting is enabled.
- Parameters
-
in_enable Whether subentity highlighting is enabled.
- Returns
- A reference to this HighlightOptionsKit.
void HPS::HighlightOptionsKit::Show | ( | HighlightOptionsKit & | out_kit | ) | const |
Copies this HighlightOptionsKit into the given HighlightOptionsKit.
- Parameters
-
out_kit The HighlightOptionsKit to populate with the contents of this HighlightOptionsKit.
bool HPS::HighlightOptionsKit::ShowNotification | ( | bool & | out_state | ) | const |
Shows the notification setting.
- Parameters
-
out_state Whether to inject a notification event after highlighting (or unhighlighting).
- Returns
- true if a notification setting was specified, false otherwise.
bool HPS::HighlightOptionsKit::ShowOverlay | ( | Drawing::Overlay & | out_overlay | ) | const |
Shows the overlay setting.
- Parameters
-
out_overlay The type of overlay, if any, used.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::HighlightOptionsKit::ShowSecondaryStyleName | ( | UTF8 & | out_style_name | ) | const |
Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).
- Parameters
-
out_style_name UTF8-encoded style name.
- Returns
- true if a style was specified, false otherwise.
bool HPS::HighlightOptionsKit::ShowStyleName | ( | UTF8 & | out_style_name | ) | const |
Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting).
- Parameters
-
out_style_name UTF8-encoded style name.
- Returns
- true if a style was specified, false otherwise.
bool HPS::HighlightOptionsKit::ShowSubentityHighlighting | ( | bool & | out_enable | ) | const |
Shows whether subentity highlighting is enabled.
- Parameters
-
out_enable Whether subentity highlighting is enabled.
- Returns
- true if a flag was specified, false otherwise.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this HighlightOptionsKit.
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetNotification | ( | ) |
Removes the notification setting.
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetOverlay | ( | ) |
Removes an overlay setting.
- Returns
- A reference to this object.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetSecondaryStyleName | ( | ) |
Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetStyleName | ( | ) |
Removes the style to apply (or unapply) when highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
HighlightOptionsKit& HPS::HighlightOptionsKit::UnsetSubentityHighlighting | ( | ) |
Removes whether subentity highlighting is enabled.
- Returns
- A reference to this HighlightOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h