REFERENCE MANUAL
The StyleKey class is a smart pointer to a database object. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.StyleKey | SetCondition (HPS.Condition in_condition) |
Sets a conditional expression on this StyleKey. More... | |
HPS.StyleKey | SetFilter (HPS.AttributeLock.Type in_type) |
Sets an attribute filter on this StyleKey. More... | |
HPS.StyleKey | SetFilter (HPS.AttributeLock.Type[] in_types) |
Sets an array of attribute filters on this StyleKey. More... | |
bool | ShowCondition (out HPS.Condition out_condition) |
Shows the conditional expression for this StyleKey. More... | |
bool | ShowFilter (out HPS.AttributeLock.Type[] out_types) |
Shows an array of the current attribute filters on this StyleKey. More... | |
bool | ShowFilter (HPS.AttributeLock.Type in_type) |
Tests if a specific attribute filter is set on this StyleKey. More... | |
bool | ShowSource (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment, out string out_name) |
Shows the source for this StyleKey. More... | |
StyleKey () | |
The default constructor creates an uninitialized StyleKey object. More... | |
StyleKey (HPS.Key in_that) | |
This constructor creates an StyleKey object that shares the underlying smart-pointer of the source Key. More... | |
StyleKey (HPS.StyleKey in_that) | |
This constructor creates an StyleKey object that shares the underlying smart-pointer of the source Key. More... | |
HPS.StyleKey | UnsetCondition () |
Removes the conditional expression on this StyleKey. More... | |
HPS.StyleKey | UnsetFilter (HPS.AttributeLock.Type in_type) |
Removes an attribute filter from this StyleKey. More... | |
HPS.StyleKey | UnsetFilter (HPS.AttributeLock.Type[] in_types) |
Removes an array of attribute filters from this StyleKey. 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 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... | |
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 () |
![]() | |
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 StyleKey class is a smart pointer to a database object.
It is a handle to a style key created by StyleControl::PushSegment.
HPS.StyleKey.StyleKey | ( | ) |
HPS.StyleKey.StyleKey | ( | HPS.Key | in_that | ) |
HPS.StyleKey.StyleKey | ( | HPS.StyleKey | in_that | ) |
|
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.Key.
HPS.StyleKey HPS.StyleKey.SetCondition | ( | HPS.Condition | in_condition | ) |
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.
in_condition | The conditional expression for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. |
HPS.StyleKey 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.
in_type | The attribute filter to set for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. |
HPS.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.
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_style_key" kindref="compound">StyleKey</ref>. |
bool HPS.StyleKey.ShowCondition | ( | out HPS.Condition | out_condition | ) |
bool HPS.StyleKey.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.
out_types | The array of attribute filters currently set on this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. |
bool HPS.StyleKey.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.
in_type | The attribute filter to test on this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. |
bool HPS.StyleKey.ShowSource | ( | out HPS.Style.Type | out_type, |
out HPS.SegmentKey | out_segment, | ||
out string | out_name | ||
) |
Shows the source for this StyleKey.
out_type | The type of source for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. This field indicates which of the following arguments are valid. |
out_segment | The segment source for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. This is only valid if out_type is <ref refid="class_h_p_s_1_1_style_1a1520cc48e274221c9f87e3e80378240aa4b77e2a9d8e9cfc299f504b32d6e3d2b" kindref="member">Style::Type::Segment</ref>. |
out_name | The name source for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. This is only valid if out_type is <ref refid="class_h_p_s_1_1_style_1a1520cc48e274221c9f87e3e80378240aa02a7d85bf0d59dff6a850fb5d7dbbe01" kindref="member">Style::Type::Named</ref>. |
HPS.StyleKey HPS.StyleKey.UnsetCondition | ( | ) |
HPS.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.
in_type | The attribute filter to remove from this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>. |
HPS.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.
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_style_key" kindref="compound">StyleKey</ref>. |