|
class | ComponentTreeItemUnknown |
|
|
override void | deleteCptr () |
|
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
|
virtual bool | IsUserDerived () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
HandleRef | sptr |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
|
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) |
|
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.
◆ ComponentTreeItem() [1/4]
HPS.ComponentTreeItem.ComponentTreeItem |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized ComponentTreeItem object. The Type() function will return Type.None.
◆ ComponentTreeItem() [2/4]
◆ ComponentTreeItem() [3/4]
◆ ComponentTreeItem() [4/4]
◆ AddChild()
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_component | The Component for this ComponentTreeItem. Should be passed to as the corresponding argument to the base constructor. |
in_type | The type for this ComponentTreeItem. Should be passed to as the corresponding argument to the base constructor. |
- Returns
- A newly created object derived from ComponentTreeItem.
◆ Assign()
◆ Collapse()
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.
◆ Equals()
Check if the source ComponentTreeItem points to the same underlying impl as this ComponentTreeItem.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ Expand()
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.
◆ GetComponent()
◆ GetItemType()
◆ GetPath()
◆ GetTitle()
string HPS.ComponentTreeItem.GetTitle |
( |
| ) |
|
|
inline |
◆ GetTree()
◆ HasChildren()
bool HPS.ComponentTreeItem.HasChildren |
( |
| ) |
|
|
inline |
◆ Hide()
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. If activated, this forces the visibility of the associated ComponentPath and all components under this path to invisible. Any visibility changes made previously at or below this path are flushed. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- See also
- OnHide
-
Show
-
Isolate
-
ResetVisibility
-
IsHidden
-
ComponentPath.Hide
-
Programming Guide: Managing Component Visibility
◆ Highlight() [1/3]
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.
- See also
- OnHighlight
◆ Highlight() [2/3]
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.
- See also
- OnHighlight
◆ Highlight() [3/3]
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_options | The highlight options used during highlighting |
- See also
- OnHighlight
◆ IsExpanded()
bool HPS.ComponentTreeItem.IsExpanded |
( |
| ) |
|
|
inline |
◆ IsHidden()
bool HPS.ComponentTreeItem.IsHidden |
( |
| ) |
|
|
inline |
◆ IsHighlighted()
bool HPS.ComponentTreeItem.IsHighlighted |
( |
| ) |
|
|
inline |
◆ Isolate()
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. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- See also
- OnHide
-
OnShow
-
Show
-
Hide
-
ResetVisibility
-
IsHidden
-
ComponentPath.Isolate
-
Programming Guide: Managing Component Visibility
◆ ObjectType()
override HPS.Type HPS.ComponentTreeItem.ObjectType |
( |
| ) |
|
|
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.
◆ OnHide()
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.
- See also
- Hide
◆ OnHighlight()
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
-
◆ OnShow()
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.
- See also
- Show
◆ OnUnhighlight()
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
-
◆ ReExpand()
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.
◆ ResetVisibility()
void HPS.ComponentTreeItem.ResetVisibility |
( |
| ) |
|
|
inline |
◆ Show()
void HPS.ComponentTreeItem.Show |
( |
| ) |
|
|
inline |
This function will cause this ComponentTreeItem to be 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. If activated, this makes the selected path visibile but preserves the model-defined visibility of any components that exist underneath the associated ComponentPath. Any visibility changes made subsequently at or below this path are honored unless they are redundant. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- See also
- OnShow
-
Hide
-
Isolate
-
ResetVisibility
-
IsHidden
-
ComponentPath.Show
-
Programming Guide: Managing Component Visibility
◆ Unhighlight() [1/3]
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.
- See also
- OnUnhighlight
◆ Unhighlight() [2/3]
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.
- See also
- OnUnhighlight
◆ Unhighlight() [3/3]
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_options | The highlight options used during unhighlighting |
- See also
- OnUnhighlight
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentTreeItem.cs