API Search || Global Search

More...

Inheritance diagram for HPS.ComponentTreeItem:
HPS.Sprocket HPS.Object

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. 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. 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. 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. More...
 
 ComponentTreeItem ()
 The default constructor creates an uninitialized ComponentTreeItem object. The Type() function will return Type.None. 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. The CADModel provided to this constructor should be accessible from the Canvas and layer associated with the ComponentTree, otherwise an exception will be thrown. 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. This constructor should be the one invoked in the overridden AddChild function. More...
 
delegate HPS.Type ComponentTreeItemDelegate_0 (IntPtr cPtr)
 
delegate void ComponentTreeItemDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate bool ComponentTreeItemDelegate_10 (IntPtr cPtr)
 
delegate void ComponentTreeItemDelegate_11 (IntPtr cPtr)
 
delegate void ComponentTreeItemDelegate_2 (IntPtr cPtr, IntPtr out_ret, IntPtr in_component, HPS.ComponentTree.ItemType in_type)
 
delegate void ComponentTreeItemDelegate_3 (IntPtr cPtr)
 
delegate void ComponentTreeItemDelegate_4 (IntPtr cPtr)
 
delegate void ComponentTreeItemDelegate_5 (IntPtr cPtr, IntPtr in_options)
 
delegate void ComponentTreeItemDelegate_6 (IntPtr cPtr, IntPtr in_options)
 
delegate void ComponentTreeItemDelegate_7 (IntPtr cPtr)
 
delegate void ComponentTreeItemDelegate_8 (IntPtr cPtr)
 
delegate HPS.Type ComponentTreeItemDelegate_9 (IntPtr cPtr)
 
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. 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. More...
 
HPS.Component GetComponent ()
 Gets the Component for this ComponentTreeItem. The type of the Component depends on the ComponentTree.ItemType for this ComponentTreeItem. More...
 
override int GetHashCode ()
 
HPS.ComponentTree.ItemType GetItemType ()
 Gets the item type for this ComponentTreeItem. This is used to determine what type of data this ComponentTreeItem represents in the ComponentTree. More...
 
HPS.ComponentPath GetPath ()
 Gets the ComponentPath corresponding to this ComponentTreeItem. More...
 
string GetTitle ()
 Gets the title for this ComponentTreeItem. This is the text that should be displayed for this ComponentTreeItem in the ComponentTree. More...
 
HPS.ComponentTree GetTree ()
 Gets the ComponentTree associated with this ComponentTreeItem. This provides a means of accessing the derived ComponentTree by this ComponentTreeItem if necessary. 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. 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. More...
 
void Highlight (ulong in_highlight_options_index)
 This function will cause this ComponentTreeItem to be highlighted with the nth option 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. More...
 
void Highlight ()
 This function will cause this ComponentTreeItem to be highlighted with the nth option 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. More...
 
void Highlight (HPS.HighlightOptionsKit in_highlight_options)
 This function will cause this ComponentTreeItem to be highlighted with the options specified. If the options requested is not part of the associated ComponentTree highlight options, it will be added to them. 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. More...
 
bool IsExpanded ()
 Indicates whether this ComponentTreeItem is currently expanded. More...
 
bool 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. More...
 
bool 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. More...
 
void Isolate (HPS.Component.Visibility in_subtree_visibility)
 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. 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. 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. More...
 
override HPS.Type ObjectType ()
 
virtual void OnHide ()
 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. More...
 
virtual void OnHighlight (HPS.HighlightOptionsKit in_options)
 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. More...
 
virtual void OnShow ()
 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. More...
 
virtual void OnUnhighlight (HPS.HighlightOptionsKit in_options)
 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. More...
 
void ReExpand ()
 Collapses this ComponentTreeItem and then re-expands the tree. It will try to preserve the original expansion state, however, if the underlying component structure has changed, the resulting expansion may look different. More...
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
void Show (HPS.Component.Visibility in_subtree_visibility)
 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. More...
 
void 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. More...
 
void Unhighlight (ulong in_highlight_options_index)
 This function will cause this ComponentTreeItem to be unhighlighted with the nth option specified in the associated ComponentTree. This will cause this item to be marked as unhighlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed. More...
 
void Unhighlight ()
 This function will cause this ComponentTreeItem to be unhighlighted with the nth option specified in the associated ComponentTree. This will cause this item to be marked as unhighlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed. More...
 
void Unhighlight (HPS.HighlightOptionsKit in_highlight_options)
 This function will cause this ComponentTreeItem to be unhighlighted with the options specified. If the options requested is not part of the associated ComponentTree highlight options, it will be added to them. This will cause this item to be marked as unhighlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes a highlight is nonsensical. In this case, no unhighlight will be performed. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual 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...
 

Static Public Member Functions

static bool operator!= (HPS.ComponentTreeItem a, HPS.ComponentTreeItem b)
 
static bool operator== (HPS.ComponentTreeItem a, HPS.ComponentTreeItem b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
virtual bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
virtual bool IsUserDerived ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Protected Attributes

HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Static Protected Attributes

static Dictionary< IntPtr,
ComponentTreeItem
cachedObjects = new Dictionary<IntPtr, ComponentTreeItem>()
 
static Dictionary< IntPtr,
WeakReference > 
cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.ComponentTreeItem.ComponentTreeItem ( )
inline

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

HPS.ComponentTreeItem.ComponentTreeItem ( HPS.ComponentTreeItem  in_that)
inline

The copy constructor creates a ComponentTreeItem object that shares the underlying smart-pointer of the source ComponentTreeItem.

Parameters
in_thatThe source ComponentTreeItem to copy.
HPS.ComponentTreeItem.ComponentTreeItem ( HPS.ComponentTree  in_tree,
HPS.CADModel  in_cad_model 
)
inline

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.

Parameters
in_treeThe ComponentTree with which to associate this new root ComponentTreeItem.
in_cad_modelThe CADModel for this root ComponentTreeItem.

ComponentTree.SetRoot

HPS.ComponentTreeItem.ComponentTreeItem ( HPS.ComponentTree  in_tree,
HPS.Component  in_component,
HPS.ComponentTree.ItemType  in_type 
)
inline

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.

Parameters
in_treeThe ComponentTree with which to associate this new ComponentTreeItem.
in_componentThe Component for this ComponentTreeItem. This value should come from the corresponding argument to AddChild.
in_typeThe type of this ComponentTreeItem. This value should come from the corresponding argument to AddChild.

AddChild

Member Function Documentation

abstract HPS.ComponentTreeItem HPS.ComponentTreeItem.AddChild ( HPS.Component  in_component,
HPS.ComponentTree.ItemType  in_type 
)
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.

Parameters
in_componentThe Component for this ComponentTreeItem. Should be passed to as the corresponding argument to the base constructor.
in_typeThe type for this ComponentTreeItem. Should be passed to as the corresponding argument to the base constructor.
Returns
A newly created object derived from ComponentTreeItem.
virtual void HPS.ComponentTreeItem.Assign ( HPS.ComponentTreeItem  in_that)
inlinevirtual

Share the underlying smart-pointer of the ComponentTreeItem source.

Parameters
in_thatThe ComponentTreeItem source of the assignment.
Returns
A reference to this ComponentTreeItem.
virtual void HPS.ComponentTreeItem.Collapse ( )
inlinevirtual

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)
inline

Check if the source ComponentTreeItem points to the same underlying impl as this ComponentTreeItem.

Parameters
in_thatThe source ComponentTreeItem to compare to this ComponentTreeItem.
Returns
true if the objects reference the same impl, false otherwise.
virtual void HPS.ComponentTreeItem.Expand ( )
inlinevirtual

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 ( )
inline

Gets the Component for this ComponentTreeItem. The type of the Component depends on the ComponentTree.ItemType for this ComponentTreeItem.

Returns
The Component for this ComponentTreeItem.
HPS.ComponentTree.ItemType HPS.ComponentTreeItem.GetItemType ( )
inline

Gets the item type for this ComponentTreeItem. This is used to determine what type of data this ComponentTreeItem represents in the ComponentTree.

Returns
The item type for this ComponentTreeItem.
HPS.ComponentPath HPS.ComponentTreeItem.GetPath ( )
inline

Gets the ComponentPath corresponding to this ComponentTreeItem.

Returns
The ComponentPath corresponding to this ComponentTreeItem.
string HPS.ComponentTreeItem.GetTitle ( )
inline

Gets the title for this ComponentTreeItem. This is the text that should be displayed for this ComponentTreeItem in the ComponentTree.

Returns
The title for this ComponentTreeItem.
HPS.ComponentTree HPS.ComponentTreeItem.GetTree ( )
inline

Gets the ComponentTree associated with this ComponentTreeItem. This provides a means of accessing the derived ComponentTree by this ComponentTreeItem if necessary.

Returns
The ComponentTree associated with this ComponentTreeItem.
bool HPS.ComponentTreeItem.HasChildren ( )
inline

Indicates whether this ComponentTreeItem has any children.

Returns
Whether this ComponentTreeItem has any children.
void HPS.ComponentTreeItem.Hide ( )
inline

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 ( ulong  in_highlight_options_index)
inline

This function will cause this ComponentTreeItem to be highlighted with the nth option 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

void HPS.ComponentTreeItem.Highlight ( )
inline

This function will cause this ComponentTreeItem to be highlighted with the nth option 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

void HPS.ComponentTreeItem.Highlight ( HPS.HighlightOptionsKit  in_highlight_options)
inline

This function will cause this ComponentTreeItem to be highlighted with the options specified. If the options requested is not part of the associated ComponentTree highlight options, it will be added to them. 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.

Parameters
in_highlight_optionsThe highlight options used during highlighting

OnHighlight

bool HPS.ComponentTreeItem.IsExpanded ( )
inline

Indicates whether this ComponentTreeItem is currently expanded.

Returns
Whether this ComponentTreeItem is currently expanded.
bool HPS.ComponentTreeItem.IsHidden ( )
inline

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.

Returns
Whether this ComponentTreeItem is currently hidden.

Hide

Show

Isolate

ComponentPath.Hide

ComponentPath.Show

ComponentPath.Isolate

bool HPS.ComponentTreeItem.IsHighlighted ( )
inline

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.

Returns
Whether this ComponentTreeItem is currently highlighted with the options specified in the associated ComponentTree.

Highlight

Unhighlight

void HPS.ComponentTreeItem.Isolate ( HPS.Component.Visibility  in_subtree_visibility)
inline

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.

Parameters
in_subtree_visibilityDictates how Isolate will interact with the visibility of components in the tree under this item.

OnHide

OnShow

void HPS.ComponentTreeItem.Isolate ( )
inline

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 void HPS.ComponentTreeItem.OnHide ( )
inlinevirtual

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 void HPS.ComponentTreeItem.OnHighlight ( HPS.HighlightOptionsKit  in_options)
inlinevirtual

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.

Parameters
in_optionsThe HighlightOptionsKit for the associated highlight.
virtual void HPS.ComponentTreeItem.OnShow ( )
inlinevirtual

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 void HPS.ComponentTreeItem.OnUnhighlight ( HPS.HighlightOptionsKit  in_options)
inlinevirtual

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.

Parameters
in_optionsThe HighlightOptionsKit for the associated unhighlight.
void HPS.ComponentTreeItem.ReExpand ( )
inline

Collapses this ComponentTreeItem and then re-expands the tree. It will try to preserve the original expansion state, however, if the underlying component structure has changed, the resulting expansion may look different.

void HPS.ComponentTreeItem.Show ( HPS.Component.Visibility  in_subtree_visibility)
inline

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.

Parameters
in_subtree_visibilityDictates how Isolate will interact with the visibility of components in the tree under this item.

OnShow

void HPS.ComponentTreeItem.Show ( )
inline

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 ( ulong  in_highlight_options_index)
inline

This function will cause this ComponentTreeItem to be unhighlighted with the nth option specified in the associated ComponentTree. This will cause this item to be marked as unhighlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed.

OnUnhighlight

void HPS.ComponentTreeItem.Unhighlight ( )
inline

This function will cause this ComponentTreeItem to be unhighlighted with the nth option specified in the associated ComponentTree. This will cause this item to be marked as unhighlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes an unhighlight is nonsensical. In this case, no unhighlight will be performed.

OnUnhighlight

void HPS.ComponentTreeItem.Unhighlight ( HPS.HighlightOptionsKit  in_highlight_options)
inline

This function will cause this ComponentTreeItem to be unhighlighted with the options specified. If the options requested is not part of the associated ComponentTree highlight options, it will be added to them. This will cause this item to be marked as unhighlighted if it isn't already. Depending on the type of the ComponentTreeItem, sometimes a highlight is nonsensical. In this case, no unhighlight will be performed.

Parameters
in_highlight_optionsThe highlight options used during unhighlighting

OnUnhighlight


The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.ComponentTreeItem.cs