
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this HighlightSearchOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.HighlightSearchOptionsKit in_kit) |
Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit. More... | |
override int | GetHashCode () |
HighlightSearchOptionsKit () | |
The default constructor creates an empty HighlightSearchOptionsKit object. More... | |
HighlightSearchOptionsKit (HPS.HighlightSearchOptionsKit in_kit) | |
The copy constructor creates a new HighlightSearchOptionsKit object that contains the same settings as the source HighlightSearchOptionsKit. 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.HighlightSearchOptionsKit in_kit) |
Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit. More... | |
HPS.HighlightSearchOptionsKit | SetOverlay (HPS.Drawing.Overlay in_overlay) |
Sets the overlay type to look for when querying highlights. Only highlights using this overlay type will be returned by highlight queries. More... | |
HPS.HighlightSearchOptionsKit | SetOverlays (HPS.Drawing.Overlay[] in_overlays) |
Sets the overlay types to look for when querying highlights. Only highlights using any overlay types in the array will be returned by highlight queries. More... | |
HPS.HighlightSearchOptionsKit | SetStyleName (string in_style_name) |
Sets the name of the style to look for when querying highlights. Only highlights using this style will be returned by highlight queries. More... | |
HPS.HighlightSearchOptionsKit | SetStyleNames (string[] in_style_names) |
Sets the names of the styles to look for when querying highlights. Only highlights using any style in the array will be returned by highlight queries. More... | |
void | Show (out HPS.HighlightSearchOptionsKit out_kit) |
Copies this HighlightSearchOptionsKit into the given HighlightSearchOptionsKit. More... | |
bool | ShowOverlays (out HPS.Drawing.Overlay[] out_overlays) |
Shows the overlay types to look for when querying highlights. More... | |
bool | ShowStyleNames (out string[] out_style_names) |
Shows the names of the styles to look for when querying highlights. More... | |
HPS.HighlightSearchOptionsKit | UnsetEverything () |
Removes all settings from this HighlightSearchOptionsKit. More... | |
HPS.HighlightSearchOptionsKit | UnsetOverlays () |
Removes all overlay filters. More... | |
HPS.HighlightSearchOptionsKit | UnsetStyleNames () |
Removes all style filters. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
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... | |
override 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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.HighlightSearchOptionsKit | GetDefault () |
Creates a HighlightSearchOptionsKit 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.HighlightSearchOptionsKit a, HPS.HighlightSearchOptionsKit b) |
static bool | operator== (HPS.HighlightSearchOptionsKit a, HPS.HighlightSearchOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HighlightSearchOptionsKit class is a user space object. It is used to filter highlight queries via HighlightControl.ShowHighlightState, HighlightControl.ShowHighlightStates, and WindowKey.FindHighlights.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty HighlightSearchOptionsKit object.
|
inline |
The copy constructor creates a new HighlightSearchOptionsKit object that contains the same settings as the source HighlightSearchOptionsKit.
- Parameters
-
in_kit The source HighlightSearchOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this HighlightSearchOptionsKit has any values set on it.
- Returns
- true if no values are set on this HighlightSearchOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.
- Parameters
-
in_kit The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates a HighlightSearchOptionsKit 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 HighlightSearchOptionsKit 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 HighlightSearchOptionsKit into this HighlightSearchOptionsKit.
- Parameters
-
in_kit The source HighlightSearchOptionsKit to copy.
|
inline |
Sets the overlay type to look for when querying highlights. Only highlights using this overlay type will be returned by highlight queries.
- Parameters
-
in_overlay Overlay type.
- Returns
- A reference to this object.
|
inline |
Sets the overlay types to look for when querying highlights. Only highlights using any overlay types in the array will be returned by highlight queries.
- Parameters
-
in_overlays Overlay types.
- Returns
- A reference to this object.
|
inline |
Sets the name of the style to look for when querying highlights. Only highlights using this style will be returned by highlight queries.
- Parameters
-
in_style_name UTF8-encoded style name.
- Returns
- A reference to this HighlightSearchOptionsKit.
|
inline |
Sets the names of the styles to look for when querying highlights. Only highlights using any style in the array will be returned by highlight queries.
- Parameters
-
in_style_names UTF8-encoded style names.
- Returns
- A reference to this HighlightSearchOptionsKit.
|
inline |
Copies this HighlightSearchOptionsKit into the given HighlightSearchOptionsKit.
- Parameters
-
out_kit The HighlightSearchOptionsKit to populate with the contents of this HighlightSearchOptionsKit.
|
inline |
Shows the overlay types to look for when querying highlights.
- Parameters
-
out_overlays Overlay types.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the names of the styles to look for when querying highlights.
- Parameters
-
out_style_names UTF8-encoded style names.
- Returns
- true if any style was specified, false otherwise.
|
inline |
Removes all settings from this HighlightSearchOptionsKit.
- Returns
- A reference to this HighlightSearchOptionsKit.
|
inline |
Removes all overlay filters.
- Returns
- A reference to this object.
|
inline |
Removes all style filters.
- Returns
- A reference to this HighlightSearchOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.HighlightSearchOptionsKit.cs