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. 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. This does not necessarily give the true type of the underlying object. 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. If any type of overlay is used, transparency in the highlighted object(s) will be ignored. 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... | |
HPS.HighlightOptionsKit | SetSubentityHighlighting (bool in_enable) |
Sets whether subentity highlighting is enabled. 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... | |
bool | ShowSubentityHighlighting (out bool out_enable) |
Shows whether subentity highlighting is enabled. 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... | |
HPS.HighlightOptionsKit | UnsetSubentityHighlighting () |
Removes whether subentity highlighting is enabled. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.HighlightOptionsKit | GetDefault () |
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. 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 |
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
|
inline |
The default constructor creates an empty HighlightOptionsKit object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
Member Function Documentation
|
inlinevirtual |
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.
|
inline |
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.
|
inlinestatic |
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.Object.
|
inline |
Copies the source HighlightOptionsKit into this HighlightOptionsKit.
- Parameters
-
in_kit The source HighlightOptionsKit to copy.
|
inline |
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.
Notification default value
|
inline |
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.
Overlay default value
|
inline |
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.
|
inline |
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.
|
inline |
Sets whether subentity highlighting is enabled.
- Parameters
-
in_enable Whether subentity highlighting is enabled.
- Returns
- A reference to this HighlightOptionsKit.
|
inline |
Copies this HighlightOptionsKit into the given HighlightOptionsKit.
- Parameters
-
out_kit The HighlightOptionsKit to populate with the contents of this HighlightOptionsKit.
|
inline |
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.
|
inline |
Shows the overlay setting.
- Parameters
-
out_overlay The type of overlay, if any, used.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
Shows whether subentity highlighting is enabled.
- Parameters
-
out_enable Whether subentity highlighting is enabled.
- Returns
- true if a flag was specified, false otherwise.
|
inline |
Removes all settings from this HighlightOptionsKit.
- Returns
- A reference to this HighlightOptionsKit.
|
inline |
Removes the notification setting.
- Returns
- A reference to this HighlightOptionsKit.
|
inline |
Removes an overlay setting.
- Returns
- A reference to this object.
|
inline |
Removes the secondary style to apply (or unapply) when highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
|
inline |
Removes the style to apply (or unapply) when highlighting (or unhighlighting).
- Returns
- A reference to this HighlightOptionsKit.
|
inline |
Removes whether subentity highlighting is enabled.
- Returns
- A reference to this HighlightOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.HighlightOptionsKit.cs