StyleKey
- class HPS.StyleKey : public HPS.Key
The StyleKey class is a smart pointer to a database object. It is a handle to a style key created by StyleControl.PushSegment.
Public Functions
- override void Dispose ()
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- HPS.StyleKey SetConditionalExpression (HPS.ConditionalExpression in_conditional)
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.
- HPS.StyleKey SetFilter (HPS.AttributeLock.Type in_type)
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.
- HPS.StyleKey SetFilter (HPS.AttributeLock.Type[] in_types)
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.
- bool ShowConditionalExpression (out HPS.ConditionalExpression out_conditional)
Shows the conditional expression for this StyleKey.
- bool ShowFilter (HPS.AttributeLock.Type in_type)
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.
- bool ShowFilter (out HPS.AttributeLock.Type[] out_types)
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.
- Param out_types
The array of attribute filters currently set on this StyleKey.
- Return
true if there are attribute filters, false otherwise.
- bool ShowSource (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment, out string out_name)
Shows the source for this StyleKey.
- Param out_type
The type of source for this StyleKey. This field indicates which of the following arguments are valid.
- Param out_segment
The segment source for this StyleKey. This is only valid if out_type is Style.Type.Segment.
- Param out_name
The name source for this StyleKey. This is only valid if out_type is Style.Type.Named.
- Return
true if there is a source for this StyleKey, false otherwise.
- StyleKey ()
The default constructor creates an uninitialized StyleKey object. The Type() function will return Type.None.
- StyleKey (HPS.Key in_that)
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 (HPS.StyleKey in_that)
The copy constructor creates a StyleKey object that shares the underlying smart-pointer of the source StyleKey.
- Param in_that
The source StyleKey to copy.
- HPS.StyleKey UnsetConditionalExpression ()
Removes the conditional expression on this StyleKey. This will turn a conditional style into an unconditional style.
- Return
A reference to this StyleKey.
- HPS.StyleKey UnsetFilter (HPS.AttributeLock.Type in_type)
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.
- HPS.StyleKey UnsetFilter (HPS.AttributeLock.Type[] in_types)
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.
