REFERENCE MANUAL
The IncludeKey class is a smart pointer to a database object. More...
Public Member Functions | |
override void | Dispose () |
HPS.SegmentKey | GetTarget () |
Gets the target, i.e., the segment to be included, for this IncludeKey. More... | |
IncludeKey () | |
The default constructor creates an uninitialized IncludeKey object. More... | |
IncludeKey (HPS.Key in_that) | |
This constructor creates an IncludeKey object that shares the underlying smart-pointer of the source Key. More... | |
IncludeKey (HPS.IncludeKey in_that) | |
This constructor creates an IncludeKey object that shares the underlying smart-pointer of the source Key. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.IncludeKey | SetCondition (HPS.Condition in_condition) |
Sets a conditional expression on this IncludeKey. More... | |
HPS.IncludeKey | SetFilter (HPS.AttributeLock.Type in_type) |
Sets an attribute filter on this IncludeKey. More... | |
HPS.IncludeKey | SetFilter (HPS.AttributeLock.Type[] in_types) |
Sets an array of attribute filters on this IncludeKey. More... | |
HPS.IncludeKey | SetPriority (int in_priority) |
Assigns a specific drawing priority value of an include. More... | |
bool | ShowCondition (out HPS.Condition out_condition) |
Shows the conditional expression for this IncludeKey. More... | |
bool | ShowFilter (out HPS.AttributeLock.Type[] out_types) |
Shows an array of the current attribute filters on this IncludeKey. More... | |
bool | ShowFilter (HPS.AttributeLock.Type in_type) |
Tests if a specific attribute filter is set on this IncludeKey. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.IncludeKey | UnsetCondition () |
Removes the conditional expression on this IncludeKey. More... | |
HPS.IncludeKey | UnsetFilter (HPS.AttributeLock.Type in_type) |
Removes an attribute filter from this IncludeKey. More... | |
HPS.IncludeKey | UnsetFilter (HPS.AttributeLock.Type[] in_types) |
Removes an array of attribute filters from this IncludeKey. More... | |
HPS.IncludeKey | UnsetPriority () |
Removes a drawing priority setting. More... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
void | Delete () |
Removes the database object referred to by this key. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
Key () | |
An uninitialized key refers to no database object and Type() will return Type::None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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 |
HandleRef | scptr |
The IncludeKey class is a smart pointer to a database object.
It is a handle to an include key created by SegmentKey::IncludeSegment.
HPS.IncludeKey.IncludeKey | ( | ) |
The default constructor creates an uninitialized IncludeKey object.
The Type() function will return Type::None.
HPS.IncludeKey.IncludeKey | ( | HPS.Key | in_that | ) |
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.
HPS.IncludeKey.IncludeKey | ( | HPS.IncludeKey | in_that | ) |
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.
HPS.SegmentKey HPS.IncludeKey.GetTarget | ( | ) |
Gets the target, i.e., the segment to be included, for this IncludeKey.
|
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.
HPS.IncludeKey HPS.IncludeKey.SetCondition | ( | HPS.Condition | in_condition | ) |
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.
in_condition | The conditional expression for this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
HPS.IncludeKey HPS.IncludeKey.SetFilter | ( | HPS.AttributeLock.Type | in_type | ) |
Sets an attribute filter on this IncludeKey.
Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
in_type | The attribute filter to set for this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
HPS.IncludeKey HPS.IncludeKey.SetFilter | ( | HPS.AttributeLock.Type[] | in_types | ) |
Sets an array of 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.
in_count | The size of the attribute filter array. |
in_types | The array of attribute filters to set for this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
HPS.IncludeKey HPS.IncludeKey.SetPriority | ( | int | in_priority | ) |
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.
in_priority | The drawing priority, higher priority items are visited before lower priority items. |
bool HPS.IncludeKey.ShowCondition | ( | out HPS.Condition | out_condition | ) |
Shows the conditional expression for this IncludeKey.
out_condition | The conditional expression for this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
bool HPS.IncludeKey.ShowFilter | ( | out HPS.AttributeLock.Type[] | out_types | ) |
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.
out_types | The array of attribute filters currently set on this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
bool HPS.IncludeKey.ShowFilter | ( | HPS.AttributeLock.Type | in_type | ) |
Tests if a specific attribute filter is set on this IncludeKey.
Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
in_type | The attribute filter to test on this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
bool HPS.IncludeKey.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
HPS.IncludeKey HPS.IncludeKey.UnsetCondition | ( | ) |
Removes the conditional expression on this IncludeKey.
This will turn a conditional include into an unconditional include.
HPS.IncludeKey HPS.IncludeKey.UnsetFilter | ( | HPS.AttributeLock.Type | in_type | ) |
Removes an attribute filter from this IncludeKey.
Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
in_type | The attribute filter to remove from this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
HPS.IncludeKey HPS.IncludeKey.UnsetFilter | ( | HPS.AttributeLock.Type[] | in_types | ) |
Removes an array of attribute filters from this IncludeKey.
Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
in_count | The size of the attribute filter array. |
in_types | The array of attribute filters to remove from this <ref refid="class_h_p_s_1_1_include_key" kindref="compound">IncludeKey</ref>. |
HPS.IncludeKey HPS.IncludeKey.UnsetPriority | ( | ) |
Removes a drawing priority setting.