REFERENCE MANUAL
The ComponentTreeItem 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. More...
Classes | |
class | ComponentTreeItemUnknown |
Public Member Functions | |
abstract HPS.ComponentTreeItem | AddChild (HPS.Component in_component, HPS.ComponentTree.ItemType in_type) |
This function is used to create a new ComponentTreeItem to be the child of this ComponentTreeItem. More... | |
virtual void | Assign (HPS.ComponentTreeItem in_that) |
Share the underlying smart-pointer of the ComponentTreeItem source. More... | |
virtual void | Collapse () |
This function should be invoked when this ComponentTreeItem needs to collapse. More... | |
ComponentTreeItem () | |
The default constructor creates an uninitialized ComponentTreeItem object. More... | |
ComponentTreeItem (HPS.ComponentTreeItem in_that) | |
The copy constructor creates a ComponentTreeItem object that shares the underlying smart-pointer of the source ComponentTreeItem. More... | |
ComponentTreeItem (HPS.ComponentTree in_tree, HPS.CADModel in_cad_model) | |
This constructor creates a ComponentTreeItem suitable for acting as a root in a ComponentTree. More... | |
ComponentTreeItem (HPS.ComponentTree in_tree, HPS.Component in_component, HPS.ComponentTree.ItemType in_type) | |
This constructor creates a ComponentTreeItem which is not suitable for acting as a root in a ComponentTree, but is suitable to be a ComponentTreeItem under the root of the ComponentTree. More... | |
delegate HPS.Type | ComponentTreeItemDelegate_0 () |
delegate void | ComponentTreeItemDelegate_1 (IntPtr in_that) |
delegate void | ComponentTreeItemDelegate_10 () |
delegate void | ComponentTreeItemDelegate_2 (IntPtr out_ret, IntPtr in_component, HPS.ComponentTree.ItemType in_type) |
delegate void | ComponentTreeItemDelegate_3 () |
delegate void | ComponentTreeItemDelegate_4 () |
delegate void | ComponentTreeItemDelegate_5 (IntPtr in_options) |
delegate void | ComponentTreeItemDelegate_6 (IntPtr in_options) |
delegate void | ComponentTreeItemDelegate_7 () |
delegate void | ComponentTreeItemDelegate_8 () |
delegate bool | ComponentTreeItemDelegate_9 () |
override void | Dispose () |
delegate void | DtorDelegate (IntPtr cPtr) |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ComponentTreeItem in_that) |
Check if the source ComponentTreeItem points to the same underlying impl as this ComponentTreeItem. More... | |
virtual void | Expand () |
This function should be invoked when this ComponentTreeItem needs to expand. More... | |
HPS.Component | GetComponent () |
Gets the Component for this ComponentTreeItem. More... | |
override int | GetHashCode () |
HPS.ComponentTree.ItemType | GetItemType () |
Gets the item type for this ComponentTreeItem. More... | |
HPS.ComponentPath | GetPath () |
Gets the ComponentPath corresponding to this ComponentTreeItem. More... | |
string | GetTitle () |
Gets the title for this ComponentTreeItem. More... | |
HPS.ComponentTree | GetTree () |
Gets the ComponentTree associated with this ComponentTreeItem. More... | |
bool | HasChildren () |
Indicates whether this ComponentTreeItem has any children. More... | |
void | Hide () |
This function will cause this ComponentTreeItem to be hidden if it isn't already. More... | |
void | Highlight () |
This function will cause this ComponentTreeItem to be highlighted with the options specified in the associated ComponentTree. More... | |
bool | IsHidden () |
Indicates whether this ComponentTreeItem is currently hidden. More... | |
bool | IsHighlighted () |
Indicates whether this ComponentTreeItem is currently highlighted with the options specified in the associated ComponentTree. More... | |
void | Isolate () |
This function will cause this ComponentTreeItem to be isolated, i.e., all other items will be hidden and this item will be shown. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
virtual void | OnHide () |
This function will be invoked when this ComponentTreeItem should be marked as hidden. More... | |
virtual void | OnHighlight (HPS.HighlightOptionsKit in_options) |
This function will be invoked when this ComponentTreeItem should be marked as highlighted. More... | |
virtual void | OnShow () |
This function will be invoked when this ComponentTreeItem should be marked as visible. More... | |
virtual void | OnUnhighlight (HPS.HighlightOptionsKit in_options) |
This function will be invoked when this ComponentTreeItem should be marked as unhighlighted. More... | |
void | Show () |
This function will cause this ComponentTreeItem to be visible if it isn't already. More... | |
void | Unhighlight () |
This function will remove the highlight with the options specified in the associated ComponentTree from this ComponentTreeItem. More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.ComponentTreeItem a, HPS.ComponentTreeItem b) |
static bool | operator== (HPS.ComponentTreeItem a, HPS.ComponentTreeItem b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
void | DtorCallback (IntPtr p) |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ComponentTreeItem 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 component or model browser.
HPS.ComponentTreeItem.ComponentTreeItem | ( | ) |
The default constructor creates an uninitialized ComponentTreeItem object.
The Type() function will return Type::None.
HPS.ComponentTreeItem.ComponentTreeItem | ( | HPS.ComponentTreeItem | in_that | ) |
The copy constructor creates a ComponentTreeItem object that shares the underlying smart-pointer of the source ComponentTreeItem.
in_that | The source <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref> to copy. |
HPS.ComponentTreeItem.ComponentTreeItem | ( | HPS.ComponentTree | in_tree, |
HPS.CADModel | in_cad_model | ||
) |
This constructor creates a ComponentTreeItem suitable for acting as a root in a ComponentTree.
The CADModel provided to this constructor should be accessible from the Canvas and layer associated with the ComponentTree, otherwise an exception will be thrown.
in_tree | The <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> with which to associate this new root <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. |
in_cad_model | The <ref refid="class_h_p_s_1_1_c_a_d_model" kindref="compound">CADModel</ref> for this root <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. |
HPS.ComponentTreeItem.ComponentTreeItem | ( | HPS.ComponentTree | in_tree, |
HPS.Component | in_component, | ||
HPS.ComponentTree.ItemType | in_type | ||
) |
This constructor creates a ComponentTreeItem which is not suitable for acting as a root in a ComponentTree, but is suitable to be a ComponentTreeItem under the root of the ComponentTree.
This constructor should be the one invoked in the overridden AddChild function.
in_tree | The <ref refid="class_h_p_s_1_1_component_tree" kindref="compound">ComponentTree</ref> with which to associate this new <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. |
in_component | The <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> for this <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. This value should come from the corresponding argument to AddChild. |
in_type | The type of this <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. This value should come from the corresponding argument to AddChild. |
AddChild
|
pure virtual |
This function is used to create a new ComponentTreeItem to be the child of this ComponentTreeItem.
This function will be invoked if this ComponentTreeItem has children and Expand has been invoked on it. This function should contain any necessary calls to GUI toolkits to create the appropriate GUI elements. Additionally, since this function requires the creation of a derived ComponentTreeItem, that derived ComponentTreeItem should use the base constructor which takes the same arguments this function.
in_component | The <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> for this <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. Should be passed to as the corresponding argument to the base constructor. |
in_type | The type for this <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. Should be passed to as the corresponding argument to the base constructor. |
|
virtual |
Share the underlying smart-pointer of the ComponentTreeItem source.
in_that | The <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref> source of the assignment. |
|
virtual |
This function should be invoked when this ComponentTreeItem 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 ComponentTreeItem when invoked.
bool HPS.ComponentTreeItem.Equals | ( | HPS.ComponentTreeItem | in_that | ) |
Check if the source ComponentTreeItem points to the same underlying impl as this ComponentTreeItem.
in_that | The source <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref> to compare to this <ref refid="class_h_p_s_1_1_component_tree_item" kindref="compound">ComponentTreeItem</ref>. |
|
virtual |
This function should be invoked when this ComponentTreeItem 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 ComponentTreeItem when invoked.
HPS.Component HPS.ComponentTreeItem.GetComponent | ( | ) |
Gets the Component for this ComponentTreeItem.
The type of the Component depends on the ComponentTree::ItemType for this ComponentTreeItem.
HPS.ComponentTree.ItemType HPS.ComponentTreeItem.GetItemType | ( | ) |
Gets the item type for this ComponentTreeItem.
This is used to determine what type of data this ComponentTreeItem represents in the ComponentTree.
HPS.ComponentPath HPS.ComponentTreeItem.GetPath | ( | ) |
Gets the ComponentPath corresponding to this ComponentTreeItem.
string HPS.ComponentTreeItem.GetTitle | ( | ) |
Gets the title for this ComponentTreeItem.
This is the text that should be displayed for this ComponentTreeItem in the ComponentTree.
HPS.ComponentTree HPS.ComponentTreeItem.GetTree | ( | ) |
Gets the ComponentTree associated with this ComponentTreeItem.
This provides a means of accessing the derived ComponentTree by this ComponentTreeItem if necessary.
bool HPS.ComponentTreeItem.HasChildren | ( | ) |
Indicates whether this ComponentTreeItem has any children.
void HPS.ComponentTreeItem.Hide | ( | ) |
This function will cause this ComponentTreeItem to be hidden if it isn't already.
This will cause this item to be marked as hidden if it isn't already. Depending on the type of the ComponentTreeItem, sometimes a hide is nonsensical. In this case, no hide will be performed.
OnHide
void HPS.ComponentTreeItem.Highlight | ( | ) |
This function will cause this ComponentTreeItem to be highlighted with the options specified in the associated ComponentTree.
This will cause this item to be marked as highlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes a highlight is nonsensical. In this case, no highlight will be performed.
OnHighlight
bool HPS.ComponentTreeItem.IsHidden | ( | ) |
Indicates whether this ComponentTreeItem is currently hidden.
This may mean that the Hide function on this ComponentTreeItem was invoked, or that the Component backing this ComponentTreeItem was hidden via ComponentPath::Hide or ComponentPath::Isolate.
Hide
Show
Isolate
bool HPS.ComponentTreeItem.IsHighlighted | ( | ) |
Indicates whether this ComponentTreeItem is currently highlighted with the options specified in the associated ComponentTree.
This may mean that the Highlight function on this ComponentTreeItem was invoked, or that the Component backing this ComponentTreeItem was highlighted by ComponentPath::Highlight.
Highlight
Unhighlight
void HPS.ComponentTreeItem.Isolate | ( | ) |
This function will cause this ComponentTreeItem to be isolated, i.e., all other items will be hidden and this item will be shown.
This will cause this item to be marked as visible if it isn't already, and all other items to be marked as hidden. Depending on the type of the ComponentTreeItem, sometimes an isolate is nonsensical. In this case, no isolate will be performed.
OnHide
OnShow
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
virtual |
This function will be invoked when this ComponentTreeItem should be marked as hidden.
This hiding may have come as a result of the Hide or Isolate function on a ComponentTreeItem being invoked, or due to ComponentPath::Hide being invoked on the Component backing this ComponentTreeItem. This function is meant to be overridden to allow one to change the appearance of a hidden ComponentTreeItem, e.g., by graying the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.
|
virtual |
This function will be invoked when this ComponentTreeItem should be marked as highlighted.
This highlighting may have come as a result of the Highlight function on a ComponentTreeItem being invoked, or due to ComponentPath::Highlight being invoked on the Component backing this ComponentTreeItem. This function is meant to be overridden to allow one to change the appearance of a highlighted ComponentTreeItem, e.g., by bolding the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.
in_options | The HighlightOptionsKit for the associated highlight. |
|
virtual |
This function will be invoked when this ComponentTreeItem should be marked as visible.
This visibility may have come as a result of the Show or Isolate function on a ComponentTreeItem being invoked, or due to ComponentPath::Show or ComponentPath::Isolate being invoked on the Component backing this ComponentTreeItem. This function is meant to be overridden to allow one to change the appearance of a visible ComponentTreeItem, e.g., by no longer graying out the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.
|
virtual |
This function will be invoked when this ComponentTreeItem should be marked as unhighlighted.
This unhighlighting may have come as a result of the Unhighlight function on a ComponentTreeItem being invoked, or due to ComponentPath::Unhighlight being invoked on the Component backing this ComponentTreeItem. This function is meant to be overridden to allow one to change the appearance of a unhighlighted ComponentTreeItem, e.g., by no longer bolding the text or changing an icon, to signify this new state. If this function is overridden, the overriding function should invoke this base function.
in_options | The HighlightOptionsKit for the associated unhighlight. |
void HPS.ComponentTreeItem.Show | ( | ) |
This function will cause this ComponentTreeItem to be visible if it isn't already.
This will cause this item to be marked as visible if it isn't already. Depending on the type of the ComponentTreeItem, sometimes a show is nonsensical. In this case, no show will be performed.
OnShow
void HPS.ComponentTreeItem.Unhighlight | ( | ) |
This function will remove the highlight with the options specified in the associated ComponentTree from this ComponentTreeItem.
This will cause this item to be marked as unhighlighted. Depending on the type of the ComponentTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed.
OnUnhighlight