|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static bool | operator!= (HPS.Key a, HPS.Key b) |
|
static bool | operator== (HPS.Key a, HPS.Key b) |
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The IncludeKey class is a smart pointer to a database object. It is a handle to an include key created by SegmentKey.IncludeSegment.
◆ IncludeKey() [1/3]
HPS.IncludeKey.IncludeKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized IncludeKey object. The Type() function will return Type.None.
◆ IncludeKey() [2/3]
HPS.IncludeKey.IncludeKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
This constructor creates an IncludeKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an include key. Otherwise the copy will fail and the resulting IncludeKey will be invalid.
- Parameters
-
in_that | The source Key to copy. |
◆ IncludeKey() [3/3]
The copy constructor creates a IncludeKey object that shares the underlying smart-pointer of the source IncludeKey.
- Parameters
-
◆ GetTarget()
Gets the target, i.e., the segment to be included, for this IncludeKey.
- Returns
- The target, i.e., the segment to be included, for this IncludeKey.
◆ ObjectType()
override HPS.Type HPS.IncludeKey.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ SetConditionalExpression()
Sets a conditional expression on this IncludeKey. This will either make an unconditional include into a conditional include, or modify the condition for an existing conditional include. The target segment referenced by this include will only be included if a condition satisfying the given conditional expression is set above this include in the tree.
- Parameters
-
in_conditional | The conditional expression for this IncludeKey. |
- Returns
- A reference to this IncludeKey.
- See also
- SegmentKey.SetCondition
-
ConditionControl.SetCondition
-
ConditionControl.AddCondition
◆ SetFilter() [1/2]
◆ SetFilter() [2/2]
◆ SetPriority()
Assigns a specific drawing priority value of an include. It affects the order in which the include is visited, if and only if the rendering algorithm is set to Priority.
- Parameters
-
in_priority | The drawing priority, higher priority items are visited before lower priority items. |
- Returns
- A reference to this object.
- See also
- SubwindowKit.SetRenderingAlgorithm()
◆ ShowConditionalExpression()
Shows the conditional expression for this IncludeKey.
- Parameters
-
out_conditional | The conditional expression for this IncludeKey. |
- Returns
- true if a conditional expression is set on this IncludeKey, false otherwise.
◆ ShowFilter() [1/2]
Shows an array of the current attribute filters on this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Parameters
-
out_types | The array of attribute filters currently set on this IncludeKey. |
- Returns
- true if there are attribute filters, false otherwise.
- See also
- IncludeKey.SetFilter
-
IncludeKey.UnsetFilter
◆ ShowFilter() [2/2]
◆ ShowPriority()
bool HPS.IncludeKey.ShowPriority |
( |
out int |
out_priority | ) |
|
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- true if the setting is valid, false otherwise.
◆ UnsetConditionalExpression()
Removes the conditional expression on this IncludeKey. This will turn a conditional include into an unconditional include.
- Returns
- A reference to this IncludeKey.
◆ UnsetFilter() [1/2]
◆ UnsetFilter() [2/2]
◆ UnsetPriority()
Removes a drawing priority setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.IncludeKey.cs