#include <hps.h>
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.
HPS::HighlightOptionsKit::HighlightOptionsKit |
( |
| ) |
|
HPS::HighlightOptionsKit::HighlightOptionsKit |
( |
char const * |
in_style_name | ) |
|
This constructor creates a HighlightOptionsKit object with the specified style name set on it.
- Parameters
-
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
-
bool HPS::HighlightOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
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.
HPS::Type HPS::HighlightOptionsKit::ObjectType |
( |
| ) |
const |
|
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::Object.
The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this HighlightOptionsKit.
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
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.
- 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.
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.
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.
Removes an overlay setting.
- Returns
- A reference to this object.
Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
Removes the style to apply (or unapply) when highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
The documentation for this class was generated from the following file:
- C:/git/visualize/hps/include/hps.h