The IncludeKey class is a smart pointer to a database object. It is a handle to an include key created by SegmentKey::IncludeSegment. More...

Inheritance diagram for HPS.IncludeKey:
HPS.Key HPS.Object

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. The Type() function will return Type::None. More...
 
 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. More...
 
 IncludeKey (HPS.IncludeKey in_that)
 The copy constructor creates a IncludeKey object that shares the underlying smart-pointer of the source IncludeKey. 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...
 
HPS.IncludeKey SetConditionalExpression (HPS.ConditionalExpression in_conditional)
 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. More...
 
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. More...
 
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. More...
 
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. More...
 
bool ShowConditionalExpression (out HPS.ConditionalExpression out_conditional)
 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. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey. More...
 
bool 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. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
HPS.IncludeKey UnsetConditionalExpression ()
 Removes the conditional expression on this IncludeKey. This will turn a conditional include into an unconditional include. More...
 
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. More...
 
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. More...
 
HPS.IncludeKey UnsetPriority ()
 Removes a drawing priority setting. More...
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 Share the underlying smart-pointer of the Key source. 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. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
override int GetHashCode ()
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
 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. This does not necessarily give the true type of the underlying object. More...
 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- Public Member Functions inherited from HPS.Object
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. 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...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Key
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The IncludeKey class is a smart pointer to a database object. It is a handle to an include key created by SegmentKey::IncludeSegment.

Constructor & Destructor Documentation

HPS.IncludeKey.IncludeKey ( )
inline

The default constructor creates an uninitialized IncludeKey object. The Type() function will return Type::None.

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_thatThe source Key to copy.
HPS.IncludeKey.IncludeKey ( HPS.IncludeKey  in_that)
inline

The copy constructor creates a IncludeKey object that shares the underlying smart-pointer of the source IncludeKey.

Parameters
in_thatThe source IncludeKey to copy.

Member Function Documentation

HPS.SegmentKey HPS.IncludeKey.GetTarget ( )
inline

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.
override HPS.Type HPS.IncludeKey.ObjectType ( )
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.

HPS.IncludeKey HPS.IncludeKey.SetConditionalExpression ( HPS.ConditionalExpression  in_conditional)
inline

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_conditionalThe conditional expression for this IncludeKey.
Returns
A reference to this IncludeKey.

SegmentKey::SetCondition

ConditionControl::SetCondition

ConditionControl::AddCondition

HPS.IncludeKey HPS.IncludeKey.SetFilter ( HPS.AttributeLock.Type  in_type)
inline

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.

Parameters
in_typeThe attribute filter to set for this IncludeKey.
Returns
A reference to this IncludeKey.

IncludeKey::UnsetFilter

IncludeKey::ShowFilter

HPS.IncludeKey HPS.IncludeKey.SetFilter ( HPS.AttributeLock.Type[]  in_types)
inline

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.

Parameters
in_typesThe array of attribute filters to set for this IncludeKey.
Returns
A reference to this IncludeKey.

IncludeKey::UnsetFilter

IncludeKey::ShowFilter

HPS.IncludeKey HPS.IncludeKey.SetPriority ( int  in_priority)
inline

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_priorityThe drawing priority, higher priority items are visited before lower priority items.
Returns
A reference to this object.

SubwindowKit::SetRenderingAlgorithm()

bool HPS.IncludeKey.ShowConditionalExpression ( out HPS.ConditionalExpression  out_conditional)
inline

Shows the conditional expression for this IncludeKey.

Parameters
out_conditionalThe conditional expression for this IncludeKey.
Returns
true if a conditional expression is set on this IncludeKey, false otherwise.
bool HPS.IncludeKey.ShowFilter ( out HPS.AttributeLock.Type[]  out_types)
inline

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_typesThe array of attribute filters currently set on this IncludeKey.
Returns
true if there are attribute filters, false otherwise.

IncludeKey::SetFilter

IncludeKey::UnsetFilter

bool HPS.IncludeKey.ShowFilter ( HPS.AttributeLock.Type  in_type)
inline

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.

Parameters
in_typeThe attribute filter to test on this IncludeKey.
Returns
true if the specified atribute filter is active on this IncludeKey, false otherwise.

IncludeKey::SetFilter

IncludeKey::UnsetFilter

bool HPS.IncludeKey.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.
HPS.IncludeKey HPS.IncludeKey.UnsetConditionalExpression ( )
inline

Removes the conditional expression on this IncludeKey. This will turn a conditional include into an unconditional include.

Returns
A reference to this IncludeKey.
HPS.IncludeKey HPS.IncludeKey.UnsetFilter ( HPS.AttributeLock.Type  in_type)
inline

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.

Parameters
in_typeThe attribute filter to remove from this IncludeKey.
Returns
A reference to this IncludeKey.

IncludeKey::SetFilter

IncludeKey::ShowFilter

HPS.IncludeKey HPS.IncludeKey.UnsetFilter ( HPS.AttributeLock.Type[]  in_types)
inline

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.

Parameters
in_typesThe array of attribute filters to remove from this IncludeKey.
Returns
A reference to this IncludeKey.

IncludeKey::SetFilter

IncludeKey::ShowFilter

HPS.IncludeKey HPS.IncludeKey.UnsetPriority ( )
inline

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