#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
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 |
( |
| ) |
|
The default constructor creates an uninitialized StyleKey object. The Type() function will return Type::None.
HPS::StyleKey::StyleKey |
( |
Key const & |
in_that | ) |
|
|
explicit |
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.
- Parameters
-
in_key | The source Key to copy. |
HPS::StyleKey::StyleKey |
( |
StyleKey const & |
in_that | ) |
|
The copy constructor creates a StyleKey object that shares the underlying smart-pointer of the source StyleKey.
- Parameters
-
HPS::StyleKey::StyleKey |
( |
StyleKey && |
in_that | ) |
|
The move constructor creates a StyleKey by transferring the underlying impl of the rvalue reference to this StyleKey thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a StyleKey to take the impl from. |
HPS::Type HPS::StyleKey::ObjectType |
( |
| ) |
const |
|
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.
Associate this StyleKey with the same underlying impl as the source StyleKey.
- Parameters
-
in_that | The source StyleKey for the assignment. |
- Returns
- A reference to this StyleKey.
The move assignment operator transfers the underlying impl of the rvalue reference to this StyleKey thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a StyleKey to take the impl from. |
- Returns
- A reference to this StyleKey.
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_condition | The conditional expression for this StyleKey. |
- Returns
- A reference to this StyleKey.
- See also
- SegmentKey::SetCondition
-
ConditionControl::SetCondition
-
ConditionControl::AddCondition
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_count | The size of the attribute filter array. |
in_types | The array of attribute filters to set for this StyleKey. |
- Returns
- A reference to this StyleKey.
- See also
- StyleKey::UnsetFilter
-
StyleKey::ShowFilter
StyleKey& HPS::StyleKey::SetFilter |
( |
AttributeLockTypeArray const & |
in_types | ) |
|
bool HPS::StyleKey::ShowCondition |
( |
Condition & |
out_condition | ) |
const |
Shows the conditional expression for this StyleKey.
- Parameters
-
out_condition | The conditional expression for this StyleKey. |
- Returns
- true if a conditional expression is set on this StyleKey, false otherwise.
bool HPS::StyleKey::ShowFilter |
( |
AttributeLockTypeArray & |
out_types | ) |
const |
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.
- See also
- StyleKey::SetFilter
-
StyleKey::UnsetFilter
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.
- See also
- StyleKey::SetFilter
-
StyleKey::UnsetFilter
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.
StyleKey& HPS::StyleKey::UnsetCondition |
( |
| ) |
|
Removes the conditional expression on this StyleKey. This will turn a conditional style into an unconditional style.
- Returns
- A reference to this StyleKey.
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_count | The size of the attribute filter array. |
in_types | The array of attribute filters to remove from this StyleKey. |
- Returns
- A reference to this StyleKey.
- See also
- StyleKey::SetFilter
-
StyleKey::ShowFilter
StyleKey& HPS::StyleKey::UnsetFilter |
( |
AttributeLockTypeArray const & |
in_types | ) |
|
The documentation for this class was generated from the following file: