Public Member Functions | Protected Member Functions | List of all members
HPS.StyleKey Class Reference

The StyleKey class is a smart pointer to a database object. It is a handle to a style key created by StyleControl::PushSegment. More...

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

Public Member Functions

override void Dispose ()
 
 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)
 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...
 
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...
 
bool ShowSource (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment, out string out_name)
 Shows the source for this StyleKey. More...
 
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. More...
 
HPS.StyleKey UnsetCondition ()
 Removes the conditional expression on this StyleKey. This will turn a conditional style into an unconditional style. More...
 
bool ShowCondition (out HPS.Condition out_condition)
 Shows the conditional expression for this StyleKey. 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...
 
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...
 
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...
 
- Public Member Functions inherited from HPS.Key
 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...
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
void Delete ()
 Removes the database object referred to by this key. 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.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
virtual void Assign (HPS.Key in_that)
 Share the smart-pointer. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.StyleKey.StyleKey ( )
inline

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

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.

HPS.StyleKey.StyleKey ( HPS.StyleKey  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.

Member Function Documentation

override HPS.Type HPS.StyleKey.ObjectType ( )
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.

HPS.StyleKey HPS.StyleKey.SetCondition ( HPS.Condition  in_condition)
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_conditionThe conditional expression for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
A reference to this StyleKey.

SegmentKey::SetCondition

ConditionControl::SetCondition

ConditionControl::AddCondition

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 <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
A reference to this StyleKey.

StyleKey::UnsetFilter

StyleKey::ShowFilter

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_countThe size of the attribute filter array.
in_typesThe array of attribute filters to set for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
A reference to this StyleKey.

StyleKey::UnsetFilter

StyleKey::ShowFilter

bool HPS.StyleKey.ShowCondition ( out HPS.Condition  out_condition)
inline

Shows the conditional expression for this StyleKey.

Parameters
out_conditionThe conditional expression for this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
true if a conditional expression is set on this StyleKey, false otherwise.
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 <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
true if there are attribute filters, false otherwise.

StyleKey::SetFilter

StyleKey::UnsetFilter

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 <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
true if the specified atribute filter is active on this StyleKey, false otherwise.

StyleKey::SetFilter

StyleKey::UnsetFilter

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 <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_segmentThe 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_nameThe 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>.
Returns
true if there is a source for this StyleKey, false otherwise.
HPS.StyleKey HPS.StyleKey.UnsetCondition ( )
inline

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

Returns
A reference to this StyleKey.
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 <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
A reference to this StyleKey.

StyleKey::SetFilter

StyleKey::ShowFilter

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_countThe size of the attribute filter array.
in_typesThe array of attribute filters to remove from this <ref refid="class_h_p_s_1_1_style_key" kindref="compound">StyleKey</ref>.
Returns
A reference to this StyleKey.

StyleKey::SetFilter

StyleKey::ShowFilter


The documentation for this class was generated from the following file: