#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The IncludeKey class is a smart pointer to a database object. It is a handle to an include key created by SegmentKey::IncludeSegment.
IncludeKey::IncludeKey |
( |
| ) |
|
The default constructor creates an uninitialized IncludeKey object. The Type() function will return Type::None.
IncludeKey::IncludeKey |
( |
Key const & |
in_that | ) |
|
|
explicit |
This constructor creates an IncludeKey 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 an include key. Otherwise the copy will fail and the resulting IncludeKey will be invalid.
- Parameters
-
in_key | The source Key to copy. |
IncludeKey::IncludeKey |
( |
IncludeKey const & |
in_that | ) |
|
The copy constructor creates a IncludeKey object that shares the underlying smart-pointer of the source IncludeKey.
- Parameters
-
The move constructor creates an IncludeKey by transferring the underlying impl of the rvalue reference to this IncludeKey thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to an IncludeKey to take the impl from. |
Gets the target, i.e., the segment to be included, for this IncludeKey.
- Returns
- The target, i.e., the segment to be included, for this IncludeKey.
Type IncludeKey::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 Key.
The move assignment operator transfers the underlying impl of the rvalue reference to this IncludeKey thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to an IncludeKey to take the impl from. |
- Returns
- A reference to this IncludeKey.
IncludeKey& IncludeKey::SetFilter |
( |
AttributeLockTypeArray const & |
in_types | ) |
|
IncludeKey& IncludeKey::SetPriority |
( |
int |
in_priority | ) |
|
Assigns a specific drawing priority value of an include. It affects the order in which the include is visited, if and only if the rendering algorithm is set to Priority.
- Parameters
-
in_priority | The drawing priority, higher priority items are visited before lower priority items. |
- Returns
- A reference to this object.
- See also
- SubwindowKit::SetRenderingAlgorithm()
bool IncludeKey::ShowCondition |
( |
Condition & |
out_condition | ) |
const |
Shows the conditional expression for this IncludeKey.
- Parameters
-
out_condition | The conditional expression for this IncludeKey. |
- Returns
- true if a conditional expression is set on this IncludeKey, false otherwise.
bool IncludeKey::ShowFilter |
( |
AttributeLockTypeArray & |
out_types | ) |
const |
Shows an array of the current attribute filters on this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Parameters
-
out_types | The array of attribute filters currently set on this IncludeKey. |
- Returns
- true if there are attribute filters, false otherwise.
- See also
- IncludeKey::SetFilter
-
IncludeKey::UnsetFilter
bool IncludeKey::ShowPriority |
( |
int & |
out_priority | ) |
const |
Shows the drawing priority.
- Parameters
-
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- true if the setting is valid, false otherwise.
Removes the conditional expression on this IncludeKey. This will turn a conditional include into an unconditional include.
- Returns
- A reference to this IncludeKey.
Removes an array of attribute filters from this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Parameters
-
in_count | The size of the attribute filter array. |
in_types | The array of attribute filters to remove from this IncludeKey. |
- Returns
- A reference to this IncludeKey.
- See also
- IncludeKey::SetFilter
-
IncludeKey::ShowFilter
IncludeKey& IncludeKey::UnsetFilter |
( |
AttributeLockTypeArray const & |
in_types | ) |
|
Removes a drawing priority setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: