
Public Member Functions | |
override void | Dispose () |
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.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. More... | |
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. More... | |
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. More... | |
bool | ShowConditionalExpression (out HPS.ConditionalExpression out_conditional) |
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. Attribute filters block the specified attributes set on the source style segment from taking effect for this StyleKey. More... | |
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. 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. The Type() function will return Type.None. More... | |
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. More... | |
StyleKey (HPS.StyleKey in_that) | |
The copy constructor creates a StyleKey object that shares the underlying smart-pointer of the source StyleKey. More... | |
HPS.StyleKey | UnsetConditionalExpression () |
Removes the conditional expression on this StyleKey. This will turn a conditional style into an unconditional style. More... | |
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. More... | |
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. More... | |
![]() | |
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 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 () |
| |
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. 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... | |
virtual 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 () |
![]() | |
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 |
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
|
inline |
|
inline |
|
inline |
Member Function Documentation
|
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.Key.
|
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_conditional The conditional expression for this StyleKey.
- Returns
- A reference to this StyleKey.
|
inline |
|
inline |
|
inline |
|
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_types The array of attribute filters currently set on this StyleKey.
- Returns
- true if there are attribute filters, false otherwise.
|
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_type The attribute filter to test on this StyleKey.
- Returns
- true if the specified atribute filter is active on this StyleKey, false otherwise.
|
inline |
Shows the source for this StyleKey.
- Parameters
-
out_type The type of source for this StyleKey. This field indicates which of the following arguments are valid. out_segment The segment source for this StyleKey. This is only valid if out_type is Style.Type.Segment. out_name The 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.
|
inline |
Removes the conditional expression on this StyleKey. This will turn a conditional style into an unconditional style.
- Returns
- A reference to this StyleKey.
|
inline |
|
inline |
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.StyleKey.cs