Sign in Join
FPDoc Onlineexperiment

TCustomShellTreeView class

In unit ShellCtrls

The base class for a tree view control used to display files, directories and other objects (such as devices) from the local file system.

Declaration

pascal
TCustomShellTreeView = class(TCustomTreeView)

Inheritance

  1. TCustomShellTreeView
  2. TCustomTreeView
  3. TCustomControl
  4. TWinControl
  5. TControl
  6. TLCLComponent
  7. TComponent
  8. TPersistent
  9. TObject

Descends from it: TShellTreeView

Description

TCustomShellTreeView is a TCustomTreeView descendant that defines the base class used to display files, directories, and other objects (such as devices) from the local file system. TCustomShellTreeView provides a hierarchical tree view for the file system objects, and is used to navigate between items in the control.

TCustomShellTreeView extends the ancestor class with properties, methods, and events needed to access, maintain, and navigate file system objects in the control. Applications should not create instances of TCustomShellTreeView; use the TShellTreeView class instead.

Event handlers inherited from TCustomTreeView may include arguments which use TCustomTreeView or TTreeNode types. When they are implemented in TCustomShellTreeView, it is often necessary to cast these arguments to the TShellTreeNode or TCustomShellTreeView types to access properties and/or methods implemented in the descendent classes.

See also

Properties

ExpandCollapseModeprotectedControls the actions performed when a tree node is expanded or collapsed on the control.
UseBuiltinIconspublicIndicates if OS-provided icons are used for entries in the Shell control.
ObjectTypespublicIndicates the file system objects displayed using the control.
ShellListViewpublicConnects this ShellTreeView to a ShellListView.
FileSortTypepublicIndicates the sort type used for items (tree nodes) on the tree view control.
RootpublicIndicates the directory or path which is the top-level node in the tree view.
PathpublicPath to the directory displayed in the shell control.
ItemspublicContains the tree nodes used to represent the hierarchical tree structure for the tree view control.

Methods

WSRegisterClassprotectedRegisters this component class with the current WidgetSet.
DoCreateNodeClassprotectedPerforms actions needed to create a new tree node in the shell control.
LoadedprotectedPerforms actions needed when LCL component streaming has been completed.
CreateNodeprotectedCreates a new tree node for the shell control.
PopulateTreeNodeWithFilesprotectedAdds tree nodes for file system objects found starting at the specified node / path.
DoSelectionChangedprotectedPerforms actions needed when a new item is selected in the shell control.
DoAddItemprotectedPerforms actions needed to add a new tree node to the shell control.
CanExpandprotectedDetermines if the specified tree node can be expanded in the shell tree view control.
CollapseprotectedRemoves child nodes (if needed) when the specified tree node is collapsed.
DrawBuiltInIconprotectedDraws the Shell Icon for the specified tree node.
ExistsAndIsValidprotectedChecks whether the specified path is a valid file system object and type for the tree view control.
GetBuiltinIconSizeprotectedGets the size for a shell icon used in the control.
NodeHasChildrenprotectedDetermines whether the specified tree view Node has child nodes.
CreatepublicConstructor for the class instance.
DestroypublicDestructor for the class instance.
GetBasePathpublicReturns the initial path in the file system hierarchy for the tree structure in the control.
GetRootPathpublicReturns the effective value for Root when an explicit value has not been assigned.
GetFilesInDirpublicFills a TStrings instance with file system objects which match the specified path and mask.
GetPathFromNodepublicReturns the path (including the file name) for the file system object represented in the specified node.
PopulateWithBaseFilespublicFills the tree view when the Root directory is empty.
RefreshpublicUpdates the tree view to display file system objects starting at the specified tree node.
UpdateViewpublicReloads the nodes for tree view control and synchronizes an associated ShellListView control.

Events

OnAddItempublicEvent handler signalled when an item (tree node) is added to the shell control.
OnSortComparepublicEvent handler signalled to compare file items in a custom sort routine.

Inherited

From TCustomTreeView (196)

AccessibilityOn Added AlphaSort ApplyStoredSelection AutoExpand BackgroundColor BeginAutoDrag BeginEditing BeginUpdate BorderStyle BorderWidth BottomItem CanChange CanCollapse CanEdit Change ClearInvisibleSelection ClearSelection Click Color ConsistencyCheck CreateNodes CreateWnd CustomDraw CustomDrawItem CustomSort DblClick DefaultItemHeight DefaultItemHeightIsStored DefaultTreeViewSort Delete DestroyWnd DisabledFontColor DoAutoAdjustLayout DoDragMsg DoEndDrag DoMouseWheel DoMouseWheelHorz DoPaint DoPaintNode DoStartDrag DragOver DropTarget EditingItem EditorEditingDone EditorKeyDown EndEditing EndUpdate EnsureNodeIsVisible EraseBackground Expand ExpandSignColor ExpandSignSize ExpandSignSizeIsStored ExpandSignType ExpandSignWidth FullCollapse FullExpand GetChildAccessibleObjectAtPos GetControlClassDefaultSize GetDragImages GetFirstMultiSelected GetHitTestInfoAt GetImageIndex GetImageSize GetInsertMarkAt GetLastMultiSelected GetMaxLvl GetMaxScrollLeft GetMaxScrollTop GetNodeAt GetNodeAtY GetNodeDrawAreaHeight GetNodeDrawAreaWidth GetNodeWithExpandSignAt GetSelectedChildAccessibleObject GetSelectedIndex HideSelection HotTrack HotTrackColor Images ImagesWidth Indent IndentIsStored InitializeWnd InsertMarkNode InsertMarkType Invalidate IsCustomDrawn IsEditing IsInsertMarkVisible IsNodeHeightFullVisible IsNodeVisible KeepCollapsedNodes KeyDown LoadFromFile LoadFromStream LockSelectionChangeEvent MakeSelectionVisible MouseDown MouseLeave MouseMove MouseUp MoveCollapse MoveEnd MoveExpand MoveHome MoveLeft MovePageDown MovePageUp MoveRight MoveSelection MoveToNextNode MoveToPrevNode MultiSelect MultiSelectStyle NodeChanged Notification OnAddition OnAdvancedCustomDraw OnAdvancedCustomDrawItem OnChange OnChanging OnCollapsed OnCollapsing OnCompare OnCreateNodeClass OnCustomCreateItem OnCustomDraw OnCustomDrawArrow OnCustomDrawItem OnDeletion OnEdited OnEditing OnEditingEnd OnExpanded OnExpanding OnGetImageIndex OnGetSelectedIndex OnHasChildren OnNodeChanged OnSelectionChanged Options Paint PathDelimiter QuadClick ReadOnly Resize RightClickSelect RowSelect SaveToFile SaveToStream ScrollBars ScrolledLeft ScrolledTop ScrollView Select Selected SelectionColor SelectionCount SelectionFontColor SelectionFontColorUsed SelectionIsHidden Selections SelectionVisible SeparatorColor SetDragMode SetInsertMark SetInsertMarkAt SetOptions ShowButtons ShowLines ShowRoot ShowSeparators SortType StateImages StateImagesWidth States StoreCurrentSelection TabStop TFindOption TFindOptions ToolTips TopItem TreeLineColor TreeLinePenStyle TripleClick UnlockSelectionChangeEvent UpdateDefaultItemHeight UpdateInsertMark WMHScroll WMKillFocus WMLButtonDown WMSetFocus WMVScroll WriteDebugReport

From TCustomControl (6)

Canvas FontChanged OnPaint PaintWindow SetColor WMPaint

From TWinControl (226)

AddControl AdjustClientRect AlignControls AllAutoSized AutoAdjustLayout AutoSizeDelayed AutoSizeDelayedHandle AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CalculatePreferredSize CanFocus CanSetFocus CanTab ChangeScale ChildClassAllowed ChildHandlesCreated ChildKey ChildSizing ClientRectNeedsInterfaceUpdate CMBiDiModeChanged CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMShowingChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParams CreateParented CreateParentedControl CreateSubClass CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DialogChar DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockManager DockOver DockSite DoConstraintsChange DoDockClientMsg DoDockOver DoEnter DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoubleBuffered DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren Focused FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildren GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetPreferredSizeClientFrame GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded InsertControl IntfGetDropFilesTarget IntfUTF8KeyPress InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnDockDrop OnDockOver OnEnter OnExit OnGetDockCaption OnGetSiteInfo OnKeyDown OnKeyPress OnKeyUp OnUnDock OnUTF8KeyPress PaintControls PaintHandler PaintTo ParentDoubleBuffered ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab RealGetText ReAlign RealizeBounds RealizeBoundsRecursive RealSetText ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetControlIndex SetDockManager SetFocus SetShape SetTempCursor ShowControl Showing TabOrder UnlockRealizeBounds Update UpdateControlState UpdateDockCaption UpdateShowing UseDockManager UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMMove WMNotify WMShowWindow WMSize WMSysChar WMSysKeyDown WMSysKeyUp WMWindowPosChanged WndProc WriteLayoutDebugReport WSSetText

From TControl (342)

AccessibleDescription AccessibleName AccessibleRole AccessibleValue Action ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize Align AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel Anchors AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSize AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDestruction BeforeDragStart BeginAutoSizing BeginDrag BiDiMode BorderSpacing BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize Caption CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds ClientHeight ClientOrigin ClientRect ClientToParent ClientToScreen ClientWidth CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentBiDiModeChanged CMParentColorChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged ColorIsStored ConstrainedResize Constraints ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DefineProperties DesktopFont DisableAutoSizing DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Dock Docked DockOrientation DockTrackNoTarget DoContextPopup DoDock DoEndDock DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheelDown DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnChangeBounds DoOnParentHandleDestruction DoOnResize DoOnShowHint DoScaleFontPPI DoStartDock DragCanceled DragCursor DragDrop Dragging DragKind DragMode EditingDone EnableAutoSizing Enabled EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass Font ForeignAnchorSideChanged FormIsUpdating GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetClientScrollOffset GetColorResolvingParent GetCursor GetDefaultColor GetDefaultDockCaption GetDefaultHeight GetDefaultWidth GetDockEdge GetEnabled GetFloating GetFloatingDockSiteClass GetLogicalClientRect GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetPreferredSize GetRGBColorResolvingParent GetScrolledClientRect GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hide Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseEnter MouseInClient OnChangeBounds OnClick OnConstrainedResize OnContextPopup OnDblClick OnDragDrop OnDragOver OnEditingDone OnEndDock OnEndDrag OnMouseDown OnMouseEnter OnMouseLeave OnMouseMove OnMouseUp OnMouseWheel OnMouseWheelDown OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnMouseWheelUp OnQuadClick OnResize OnShowHint OnStartDock OnStartDrag OnTripleClick Parent ParentBackground ParentBiDiMode ParentColor ParentDestroyingHandle ParentFont ParentFontChanged ParentShowHint ParentToClient Perform PopupMenu PositionDockRect ReadBounds ReadState RemoveAllHandlersOfObject RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl RequestAlign Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToClient ScreenToControl SendToBack SessionProperties SetAction SetAlign SetAnchors SetAutoSize SetBiDiMode SetBoundsKeepBase SetCursor SetEnabled SetHint SetInitialBounds SetName SetParent SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf SetVisible SetZOrder ShouldAutoAdjust Show ShowHelp ShowHint TBDockHeight Text TextChanged Top UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar Visible VisibleChanged VisibleChanging Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp

From TLCLComponent (6)

DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass

From TComponent (64)

_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (4)

Assign FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (35)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.