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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.StyleKey SetConditionalExpression (HPS.ConditionalExpression in_conditional)
 
HPS.StyleKey SetFilter (HPS.AttributeLock.Type in_type)
 
HPS.StyleKey SetFilter (HPS.AttributeLock.Type[] in_types)
 
bool ShowConditionalExpression (out HPS.ConditionalExpression out_conditional)
 
bool ShowFilter (out HPS.AttributeLock.Type[] out_types)
 
bool ShowFilter (HPS.AttributeLock.Type in_type)
 
bool ShowSource (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment, out string out_name)
 
 StyleKey ()
 
 StyleKey (HPS.Key in_that)
 
 StyleKey (HPS.StyleKey in_that)
 
HPS.StyleKey UnsetConditionalExpression ()
 
HPS.StyleKey UnsetFilter (HPS.AttributeLock.Type in_type)
 
HPS.StyleKey UnsetFilter (HPS.AttributeLock.Type[] in_types)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
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)
 
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.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 StyleKey class is a smart pointer to a database object. It is a handle to a style key created by StyleControl.PushSegment.

Constructor & Destructor Documentation

◆ StyleKey() [1/3]

HPS.StyleKey.StyleKey ( )
inline

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

◆ StyleKey() [2/3]

HPS.StyleKey.StyleKey ( HPS.Key  in_that)
inline

This constructor creates an StyleKey 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 a style key. Otherwise the copy will fail and the resulting StyleKey will be invalid.

◆ StyleKey() [3/3]

HPS.StyleKey.StyleKey ( HPS.StyleKey  in_that)
inline

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

Parameters
in_thatThe source StyleKey to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.StyleKey.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.Key.

◆ SetConditionalExpression()

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

Sets a conditional expression on this StyleKey. This will either make an unconditional style into a conditional style, or modify the condition for an existing conditional style. The target segment referenced by this style will only be styled in if a condition satisfying the given conditional expression is set above this style in the tree.

Parameters
in_conditionalThe conditional expression for this StyleKey.
Returns
A reference to this StyleKey.
See also
SegmentKey.SetCondition
ConditionControl.SetCondition
ConditionControl.AddCondition

◆ SetFilter() [1/2]

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

Sets an attribute filter on this StyleKey. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey.

Parameters
in_typeThe attribute filter to set for this StyleKey.
Returns
A reference to this StyleKey.
See also
StyleKey.UnsetFilter
StyleKey.ShowFilter

◆ SetFilter() [2/2]

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

Sets an array of attribute filters on this StyleKey. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey.

Parameters
in_typesThe array of attribute filters to set for this StyleKey.
Returns
A reference to this StyleKey.
See also
StyleKey.UnsetFilter
StyleKey.ShowFilter

◆ ShowConditionalExpression()

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

Shows the conditional expression for this StyleKey.

Parameters
out_conditionalThe conditional expression for this StyleKey.
Returns
true if a conditional expression is set on this StyleKey, false otherwise.

◆ ShowFilter() [1/2]

bool HPS.StyleKey.ShowFilter ( out HPS.AttributeLock.Type []  out_types)
inline

Shows an array of the current attribute filters on this StyleKey. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey.

Parameters
out_typesThe array of attribute filters currently set on this StyleKey.
Returns
true if there are attribute filters, false otherwise.
See also
StyleKey.SetFilter
StyleKey.UnsetFilter

◆ ShowFilter() [2/2]

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

Tests if a specific attribute filter is set on this StyleKey. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey.

Parameters
in_typeThe attribute filter to test on this StyleKey.
Returns
true if the specified atribute filter is active on this StyleKey, false otherwise.
See also
StyleKey.SetFilter
StyleKey.UnsetFilter

◆ ShowSource()

bool HPS.StyleKey.ShowSource ( out HPS.Style.Type  out_type,
out HPS.SegmentKey  out_segment,
out string  out_name 
)
inline

Shows the source for this StyleKey.

Parameters
out_typeThe type of source for this StyleKey. This field indicates which of the following arguments are valid.
out_segmentThe segment source for this StyleKey. This is only valid if out_type is Style.Type.Segment.
out_nameThe name source for this StyleKey. This is only valid if out_type is Style.Type.Named.
Returns
true if there is a source for this StyleKey, false otherwise.

◆ UnsetConditionalExpression()

HPS.StyleKey HPS.StyleKey.UnsetConditionalExpression ( )
inline

Removes the conditional expression on this StyleKey. This will turn a conditional style into an unconditional style.

Returns
A reference to this StyleKey.

◆ UnsetFilter() [1/2]

HPS.StyleKey HPS.StyleKey.UnsetFilter ( HPS.AttributeLock.Type  in_type)
inline

Removes an attribute filter from this StyleKey. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey.

Parameters
in_typeThe attribute filter to remove from this StyleKey.
Returns
A reference to this StyleKey.
See also
StyleKey.SetFilter
StyleKey.ShowFilter

◆ UnsetFilter() [2/2]

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

Removes an array of attribute filters from this StyleKey. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey.

Parameters
in_typesThe array of attribute filters to remove from this StyleKey.
Returns
A reference to this StyleKey.
See also
StyleKey.SetFilter
StyleKey.ShowFilter

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.StyleKey.cs