#include <sprk_hca.h>
|
static const HPS::Type | staticType = HPS::Type::HCAModelTreeItem |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The ModelTreeItem class is a smart pointer which corresponds to an item or node in a tree object in a GUI toolkit, e.g., a TreeViewItem in WPF or an HTREEITEM in MFC. This class must be derived from to facilitate tree creation in the various GUI toolkits. It is used to represent items in a model browser.
◆ ModelTreeItem() [1/5]
HPS::HCA::ModelTreeItem::ModelTreeItem |
( |
| ) |
|
The default constructor creates an uninitialized ModelTreeItem object. The Type() function will return Type::None.
◆ ModelTreeItem() [2/5]
HPS::HCA::ModelTreeItem::ModelTreeItem |
( |
ModelTreeItem const & |
in_that | ) |
|
The copy constructor creates a ModelTreeItem object that shares the underlying smart-pointer of the source ModelTreeItem.
- Parameters
-
◆ ModelTreeItem() [3/5]
HPS::HCA::ModelTreeItem::ModelTreeItem |
( |
ModelTreeItem && |
in_that | ) |
|
The move constructor creates a ModelTreeItem by transferring the underlying object of the rvalue reference to this ModelTreeItem.
- Parameters
-
in_that | An rvalue reference to a ModelTreeItem to take the underlying object from. |
◆ ModelTreeItem() [4/5]
HPS::HCA::ModelTreeItem::ModelTreeItem |
( |
ModelTreePtr const & |
in_tree, |
|
|
HCA::Model const & |
in_hca_model |
|
) |
| |
◆ ModelTreeItem() [5/5]
HPS::HCA::ModelTreeItem::ModelTreeItem |
( |
ModelTreePtr const & |
in_tree, |
|
|
int64_t |
in_node_id |
|
) |
| |
This constructor creates a ModelTreeItem which is not suitable for acting as a root in a ModelTree, but is suitable to be a ModelTreeItem under the root of the ModelTree. This constructor should be the one invoked in the overridden AddChild function.
◆ AddChild()
virtual ModelTreeItemPtr HPS::HCA::ModelTreeItem::AddChild |
( |
int64_t |
in_node_id | ) |
|
|
pure virtual |
◆ Assign()
virtual void HPS::HCA::ModelTreeItem::Assign |
( |
ModelTreeItem const & |
in_that | ) |
|
|
virtual |
◆ Collapse()
virtual void HPS::HCA::ModelTreeItem::Collapse |
( |
| ) |
|
|
virtual |
This function should be invoked when this ModelTreeItem needs to collapse. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always release all children for this ModelTreeItem when invoked.
◆ Equals()
bool HPS::HCA::ModelTreeItem::Equals |
( |
ModelTreeItem const & |
in_that | ) |
const |
Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ Expand()
virtual void HPS::HCA::ModelTreeItem::Expand |
( |
| ) |
|
|
virtual |
This function should be invoked when this ModelTreeItem needs to expand. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always repopulate the children for this ModelTreeItem when invoked.
◆ GetItemType()
◆ GetNodeId()
uint64_t HPS::HCA::ModelTreeItem::GetNodeId |
( |
| ) |
const |
◆ GetTitle()
UTF8 HPS::HCA::ModelTreeItem::GetTitle |
( |
| ) |
const |
◆ GetTree()
ModelTreePtr HPS::HCA::ModelTreeItem::GetTree |
( |
| ) |
const |
◆ HasChildren()
bool HPS::HCA::ModelTreeItem::HasChildren |
( |
| ) |
const |
◆ Hide()
void HPS::HCA::ModelTreeItem::Hide |
( |
| ) |
|
This function will cause this ModelTreeItem to be hidden if it isn't already.
◆ Highlight()
This function will cause this ModelTreeItem to be highlighted with the options specified.
◆ IsExpanded()
bool HPS::HCA::ModelTreeItem::IsExpanded |
( |
| ) |
const |
◆ IsHidden()
bool HPS::HCA::ModelTreeItem::IsHidden |
( |
| ) |
const |
◆ IsHighlighted()
bool HPS::HCA::ModelTreeItem::IsHighlighted |
( |
| ) |
const |
◆ Isolate()
void HPS::HCA::ModelTreeItem::Isolate |
( |
| ) |
|
◆ ObjectType()
HPS::Type HPS::HCA::ModelTreeItem::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
◆ OnHighlightUnhighlight()
virtual void HPS::HCA::ModelTreeItem::OnHighlightUnhighlight |
( |
| ) |
|
|
virtual |
This function will be invoked when this tree should update it's highlighted icons.
◆ OnShowHide()
virtual void HPS::HCA::ModelTreeItem::OnShowHide |
( |
| ) |
|
|
inlinevirtual |
This function will be invoked when the tree should update it's show hide icons.
◆ operator!=()
bool HPS::HCA::ModelTreeItem::operator!= |
( |
ModelTreeItem const & |
in_that | ) |
const |
Check if the source ModelTreeItem points to a different impl than this ModelTreeItem.
- Parameters
-
- Returns
- true if the objects reference different impls, false otherwise.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying object of the rvalue reference to this ModelTreeItem.
- Parameters
-
in_that | An rvalue reference to a ModelTreeItem to take the underlying object from. |
- Returns
- A reference to this ModelTreeItem.
◆ operator==()
bool HPS::HCA::ModelTreeItem::operator== |
( |
ModelTreeItem const & |
in_that | ) |
const |
Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ RequestProperties()
bool HPS::HCA::ModelTreeItem::RequestProperties |
( |
uint32_t & |
out_request_id | ) |
|
◆ Show()
void HPS::HCA::ModelTreeItem::Show |
( |
| ) |
|
This function will cause this ModelTreeItem to be visible if it isn't already.
◆ ShowAll()
void HPS::HCA::ModelTreeItem::ShowAll |
( |
| ) |
|
This function will cause the visibility of this ModelTreeItem to be reset
◆ Unhighlight()
void HPS::HCA::ModelTreeItem::Unhighlight |
( |
| ) |
|
◆ Zoom()
void HPS::HCA::ModelTreeItem::Zoom |
( |
| ) |
|
The documentation for this class was generated from the following file: