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

Public Member Functions

override void Dispose ()
 
HPS.SegmentKey GetTarget ()
 
 IncludeKey ()
 
 IncludeKey (HPS.Key in_that)
 
 IncludeKey (HPS.IncludeKey in_that)
 
override HPS.Type ObjectType ()
 
HPS.IncludeKey SetConditionalExpression (HPS.ConditionalExpression in_conditional)
 
HPS.IncludeKey SetFilter (HPS.AttributeLock.Type in_type)
 
HPS.IncludeKey SetFilter (HPS.AttributeLock.Type[] in_types)
 
HPS.IncludeKey SetPriority (int in_priority)
 
bool ShowConditionalExpression (out HPS.ConditionalExpression out_conditional)
 
bool ShowFilter (out HPS.AttributeLock.Type[] out_types)
 
bool ShowFilter (HPS.AttributeLock.Type in_type)
 
bool ShowPriority (out int out_priority)
 
HPS.IncludeKey UnsetConditionalExpression ()
 
HPS.IncludeKey UnsetFilter (HPS.AttributeLock.Type in_type)
 
HPS.IncludeKey UnsetFilter (HPS.AttributeLock.Type[] in_types)
 
HPS.IncludeKey UnsetPriority ()
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
override HPS.Type ObjectType ()
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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
 

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

◆ 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_thatThe source Key to copy.

◆ IncludeKey() [3/3]

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

◆ GetTarget()

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.

◆ 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()

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.
See also
SegmentKey.SetCondition
ConditionControl.SetCondition
ConditionControl.AddCondition

◆ SetFilter() [1/2]

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.
See also
IncludeKey.UnsetFilter
IncludeKey.ShowFilter

◆ SetFilter() [2/2]

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.
See also
IncludeKey.UnsetFilter
IncludeKey.ShowFilter

◆ SetPriority()

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.
See also
SubwindowKit.SetRenderingAlgorithm()

◆ ShowConditionalExpression()

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.

◆ ShowFilter() [1/2]

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.
See also
IncludeKey.SetFilter
IncludeKey.UnsetFilter

◆ ShowFilter() [2/2]

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.
See also
IncludeKey.SetFilter
IncludeKey.UnsetFilter

◆ ShowPriority()

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.

◆ UnsetConditionalExpression()

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.

◆ UnsetFilter() [1/2]

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.
See also
IncludeKey.SetFilter
IncludeKey.ShowFilter

◆ UnsetFilter() [2/2]

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.
See also
IncludeKey.SetFilter
IncludeKey.ShowFilter

◆ UnsetPriority()

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