REFERENCE MANUAL
The HighlightOptionsKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this HighlightOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.HighlightOptionsKit in_kit) |
Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit. More... | |
override int | GetHashCode () |
HighlightOptionsKit () | |
The default constructor creates an empty HighlightOptionsKit object. More... | |
HighlightOptionsKit (string in_style_name) | |
This constructor creates a HighlightOptionsKit object with the specified style name set on it. More... | |
HighlightOptionsKit (string in_style_name, string in_secondary_style_name) | |
This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it. More... | |
HighlightOptionsKit (HPS.HighlightOptionsKit in_kit) | |
The copy constructor creates a new HighlightOptionsKit object that contains the same settings as the source HighlightOptionsKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.HighlightOptionsKit in_kit) |
Copies the source HighlightOptionsKit into this HighlightOptionsKit. More... | |
HPS.HighlightOptionsKit | SetNotification (bool in_state) |
Whether to inject a notification event after highlighting (or unhighlighting). More... | |
HPS.HighlightOptionsKit | SetOverlay (HPS.Drawing.Overlay in_overlay) |
Allows highlighting to take place in a segment without triggering a full-screen redraw. More... | |
HPS.HighlightOptionsKit | SetSecondaryStyleName (string in_style_name) |
Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting). More... | |
HPS.HighlightOptionsKit | SetStyleName (string in_style_name) |
Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting). More... | |
void | Show (out HPS.HighlightOptionsKit out_kit) |
Copies this HighlightOptionsKit into the given HighlightOptionsKit. More... | |
bool | ShowNotification (out bool out_state) |
Shows the notification setting. More... | |
bool | ShowOverlay (out HPS.Drawing.Overlay out_overlay) |
Shows the overlay setting. More... | |
bool | ShowSecondaryStyleName (out string out_style_name) |
Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting). More... | |
bool | ShowStyleName (out string out_style_name) |
Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting). More... | |
HPS.HighlightOptionsKit | UnsetEverything () |
Removes all settings from this HighlightOptionsKit. More... | |
HPS.HighlightOptionsKit | UnsetNotification () |
Removes the notification setting. More... | |
HPS.HighlightOptionsKit | UnsetOverlay () |
Removes an overlay setting. More... | |
HPS.HighlightOptionsKit | UnsetSecondaryStyleName () |
Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting). More... | |
HPS.HighlightOptionsKit | UnsetStyleName () |
Removes the style to apply (or unapply) when highlighting (or unhighlighting). More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.HighlightOptionsKit | GetDefault () |
Creates a HighlightOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.HighlightOptionsKit a, HPS.HighlightOptionsKit b) |
static bool | operator== (HPS.HighlightOptionsKit a, HPS.HighlightOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The HighlightOptionsKit class is a user space object.
It is used to hold settings needed when performing a highlight or unhighlight. HighlightOptionsKit::GetDefault() will return a highlight options kit with values found in this table.
HPS.HighlightOptionsKit.HighlightOptionsKit | ( | ) |
The default constructor creates an empty HighlightOptionsKit object.
HPS.HighlightOptionsKit.HighlightOptionsKit | ( | string | in_style_name | ) |
This constructor creates a HighlightOptionsKit object with the specified style name set on it.
in_style_name | The style name to set on this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightOptionsKit.HighlightOptionsKit | ( | string | in_style_name, |
string | in_secondary_style_name | ||
) |
This constructor creates a HighlightOptionsKit object with the specified style and secondary style names set on it.
in_style_name | The style name to set on this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
in_secondary_style_name | The style name to set on this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
HPS.HighlightOptionsKit.HighlightOptionsKit | ( | HPS.HighlightOptionsKit | in_kit | ) |
The copy constructor creates a new HighlightOptionsKit object that contains the same settings as the source HighlightOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this HighlightOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.HighlightOptionsKit.Equals | ( | HPS.HighlightOptionsKit | in_kit | ) |
Check if the source HighlightOptionsKit is equivalent to this HighlightOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
|
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.HighlightOptionsKit.Set | ( | HPS.HighlightOptionsKit | in_kit | ) |
Copies the source HighlightOptionsKit into this HighlightOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to copy. |
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetNotification | ( | bool | in_state | ) |
Whether to inject a notification event after highlighting (or unhighlighting).
in_state | Whether to inject a notification event after highlighting (or unhighlighting). |
Notification default value
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetOverlay | ( | HPS.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.
in_overlay | The type of overlay, if any, to be used. |
Overlay default value
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetSecondaryStyleName | ( | string | in_style_name | ) |
Sets the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).
in_style_name | UTF8-encoded style name. |
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.SetStyleName | ( | string | in_style_name | ) |
Sets the name of the style to apply (or unapply) when highlighting (or unhighlighting).
in_style_name | UTF8-encoded style name. |
void HPS.HighlightOptionsKit.Show | ( | out HPS.HighlightOptionsKit | out_kit | ) |
Copies this HighlightOptionsKit into the given HighlightOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_highlight_options_kit" kindref="compound">HighlightOptionsKit</ref>. |
bool HPS.HighlightOptionsKit.ShowNotification | ( | out bool | out_state | ) |
Shows the notification setting.
out_state | Whether to inject a notification event after highlighting (or unhighlighting). |
bool HPS.HighlightOptionsKit.ShowOverlay | ( | out HPS.Drawing.Overlay | out_overlay | ) |
Shows the overlay setting.
out_overlay | The type of overlay, if any, used. |
bool HPS.HighlightOptionsKit.ShowSecondaryStyleName | ( | out string | out_style_name | ) |
Shows the name of the secondary style to apply (or unapply) when highlighting (or unhighlighting).
out_style_name | UTF8-encoded style name. |
bool HPS.HighlightOptionsKit.ShowStyleName | ( | out string | out_style_name | ) |
Shows the name of the style to apply (or unapply) when highlighting (or unhighlighting).
out_style_name | UTF8-encoded style name. |
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this HighlightOptionsKit.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetNotification | ( | ) |
Removes the notification setting.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetOverlay | ( | ) |
Removes an overlay setting.
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetSecondaryStyleName | ( | ) |
Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).
HPS.HighlightOptionsKit HPS.HighlightOptionsKit.UnsetStyleName | ( | ) |
Removes the style to apply (or unapply) when highlighting (or unhighlighting).