JamShellBreadCrumbBar.TJamShellBreadCrumbBar

The TJamShellBreadCrumbBar integrates the breadcrumb navigation introduced with Windows Vista Explorer. It presents the folder and subfolder structures and enables users to easily switch between different folders.

Class Hierarchy

Syntax

Pascal

TJamShellBreadCrumbBar = class(TCustomBreadCrumbControl, IJamShellControl);

Remarks

There are three additional panes that can be shown using the VisiblePanes property: The bpHistory on the left side shows a TJamShellHistoryPane to control the history of visited folders, the bpRefreshButton shows a refresh button next to the addressbar and the bpSearchEdit provides a search for files and folders similar to the search box in Windows Explorer.

By default, the dropdown list of the BreadCrumbBar displays the "recently typed paths". You can customize this list, by calling TJamShellBreadCrumbBar.SetCustomDropDownList in e.g. the "OnCreate" eventhandler of the form.

Namespace

JamShellBreadCrumbBar

Public Methods

	Name	Description
	constructor Create(pOwner: TComponent); override;	Constructor for creating a TCustomBreadCrumbControl instance.
	destructor Destroy; override;	Destructor for destroying a TCustomBreadCrumbControl instance.

JamShellBreadCrumbBar.TJamShellBreadCrumbBar

	Name	Description
	constructor Create(pOwner: TComponent); override;	Constructor for creating a TJamShellBreadCrumbBar instance.
	destructor Destroy; override;	Destructor for destroying a TJamShellBreadCrumbBar instance.

TCustomBreadCrumbControl Events

	Name	Description
	property OnBreadCrumbClick: TBreadCrumbsClickEvent read FOnBreadCrumbClick write FOnBreadCrumbClick;	Occurs when the user clicks on an item.
	property OnEndEdit: TBreadCrumbsEndEditEvent read FOnEndEdit write FOnEndEdit;	Occurs when the control leaves edit mode.
	property OnItemClick: TBreadCrumbsItemClickEvent read FOnItemClick write FOnItemClick;	Occurs when an item in the breadcrumbbar was clicked.
	property OnMenuItemClick: TBreadCrumbsMenuItemClickEvent read FOnMenuItemClick write FOnMenuItemClick;	Occurs when a menu item in the breadcrumbbar was clicked.

JamShellBreadCrumbBar.TJamShellBreadCrumbBar

	Name	Description
	property OnAddItem: TOnAddShellBreadCrumbItem read fOnAddItem write fOnAddItem;	Occurs when a TJamShellBreadCrumbItem was added.
	property OnEndEdit;	Occurs when the control leaves edit mode.
	property OnItemClick;	Occurs when an item in the breadcrumbbar was clicked.
	property OnMenuItemClick;	Occurs when a menu item in the breadcrumbbar was clicked.

TCustomBreadCrumbControl Methods

	Name	Description
	procedure BeginEdit; virtual;	Puts the control into edit mode.
	procedure CloseMenu; virtual; abstract;	Closes the drop-down menu.
	procedure EndEdit(pApply: Boolean); virtual;	Ends the edit mode.
	procedure ResetState;	Resets the control state.
	procedure SetFocus; override;	Sets the keyboard focus to the current window.

ShellLink.IJamShellControl

	Name	Description
	procedure FileChanged(FolderPIDL: IItemIdList; FilePIDL: IItemIdList);	This method is called by the ShellLink instance if the currently selected item has changed.
	function getShellLink: TJamShellLink;	Getter method for the ShellLink property.
	function GoUp: Boolean;	This method indicates that the callee should go up one level and display the contents of the current folder's parent folder.
	procedure PathChanged(FolderPIDL: IItemIdList);	This method is called by the ShellLink instance if the currently displayed folder has changed.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure SelectAll;	This method indicates that the callee should select all item it currently displays.
	procedure setShellLink(aValue: TJamShellLink);	Setter method for the ShellLink property.

JamShellBreadCrumbBar.TJamShellBreadCrumbBar

	Name	Description
	procedure CloseMenu; override;	Closes the drop-down menu.
	procedure FullRefresh;	Refreshes the information displayed in this control.
	procedure Select(const pItemIdList: IItemIdList); deprecated;	Selects the given ItemIdList.
	procedure SetCustomDropDownList(const pFolders: TStrings; pClear: Boolean = True);	Sets custom entries in the BreadCrumbbar's DropDown list.

TCustomBreadCrumbControl Properties

	Name	Description
	property Align default alTop;	Determines how the control aligns within its container (parent control).
	property BorderStyle: TBorderStyle read FBorderStyle write SetBorderStyle default bsSingle;	Specifies the appearance and behavior of the form border.
	property ButtonDown: Boolean read FButtonDown write SetButtonDown;	Specifies if the items are in the ButtonDown state.
	property Color;	Specifies the background color of the control.
	property ComboButtonHint: string read FComboButtonHint write FComboButtonHint;	Specifies the hint value of the combo button.
	property DefaultImageIndex: Integer read FDefaultImageIndex write SetDefaultImageIndex default -;	Specifies the image index used if an item does not have an image.
	property EditMode: Boolean read GetEditMode write SetEditMode;	Specifies if the control is in edit mode.
	property GlyphIndex: Integer read GetGlyphIndex;	Gets the currently displayed image index.
	property HasComboButton: Boolean read FHasComboButton write SetHasComboButton default True;	Specifies if the control has a combo button.
	property Height stored False;	Specifies the vertical size of the control in pixels.
	property Hot: Boolean read FHot;	Determines if the mouse is hovering over the control.
	property Images: TCustomImageList read FImages write SetImages;	Specifies the image list used to display item glyphs.
	property ItemFocused: TBreadCrumbItem read GetItemFocused;	Gets the breadcrumb item that has currently the focus.
	property Items: TBreadCrumbItems read FItems write SetItems;	A collection of bread crumb items.
	property OnBeginEdit: TNotifyEvent read FOnBeginEdit write FOnBeginEdit;	Occurs when the control goes into edit mode.
	property OnClick;	Occurs when the user clicks the control.
	property OnComboClick: TNotifyEvent read FOnComboClick write FOnComboClick;	Occurs when the user clicks on the combo box button.
	property OnPathChanged: TNotifyEvent read fOnPathChanged write fOnPathChanged;	Occurs if Path has changed.
	property OnResize;	Occurs when the control is resized.
	property OverflowCount: Integer read FOverflowCount write FOverflowCount;	Determine the number of items that have been overflowed.
	property ParentColor;	Determines where a control looks for its color information.
	property ParentFont: Boolean read GetParentFont write SetParentFont default False;	Specifies where a control looks for its font information.
	property Path: TFileName read GetPath write SetPath;	Path represents the items as a string.
	property ReservedSpace: Integer read FReservedSpace write SetReservedSpace default 16;	Specifies the minimal amount of space, in pixels, between the last item and the combo button.
	property ShowErrorMessages: Boolean read GetShowErrorMessages write SetShowErrorMessages default False;	Allow Windows error messages.
	property Style: TBreadCrumbStyle read FStyle write SetStyle default bsBreadCrumbThemed;	Specifies the rendering style of the control.
	property TextMargin: Integer read FTextMargin write FTextMargin default 6;	Specifies the amount of space, in pixels, to the left and right of captions.
	property UseSystemFont: Boolean read fUseSystemFont write SetUseSystemFont default True;	Set this property to true if you want the component to utilize the default system font.
	property Version: string read GetVersion stored False;	The current version of the ShellBrowser components.

ShellLink.IJamShellControl

	Name	Description
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.

JamShellBreadCrumbBar.TJamShellBreadCrumbBar

	Name	Description
	property AbsoluteItemIdList: IItemIdList read GetAbsoluteItemIdList write SetAbsoluteItemIdList;	Gets or sets the absolute ItemIdList that is currently split up as breadcrumb items in the control.
	property Align;	Determines how the control aligns within its container (parent control).
	property Anchors;	Specifies how the control is anchored to its parent.
	property AutomaticRefresh: Boolean read fAutomaticRefresh write SetAutomaticRefresh default True;	Receives notifications about changes in the shell and performs refreshes automatically.
	property BorderStyle;	Specifies the appearance and behavior of the form border.
	property Color;	Specifies the background color of the control.
	property ComboButtonHint;	Specifies the hint value of the combo button.
	property DropDownItem: TBreadCrumbItem read fDropDownItem;	Gives reading access to the TBreadCrumbItem that was clicked last.
	property Editor;	The in-place editor.
	property Enabled;	Controls whether the control responds to mouse, keyboard, and timer events.
	property FileSystemOnly: Boolean read fFileSystemOnly write SetFileSystemOnly default False;	Use FileSystemOnly to determine if only file system objects should be displayed.
	property Font;	Specifies the attributes of text written on or in the control.
	property Framed: Boolean write SetFramed stored False;	Specifies if the control should draw a frame around itself.
	property HasComboButton;	Specifies if the control has a combo button.
	property HistoryPane: TJamShellHistoryPane read fHistoryPane;	The TJamShellHistoryPane in top left corner of the window.
	property Images;	Specifies the image list used to display item glyphs.
	property OnBeginEdit;	Occurs when the control goes into edit mode.
	property OnClick;	Occurs when the user clicks the control.
	property OnComboClick;	Occurs when the user clicks on the combo box button.
	property OnContextPopup;	Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).
	property OnEnter;	Occurs when a control receives the input focus.
	property OnExit;	Occurs when the input focus shifts away from one control to another.
	property OnPathChanged;	Occurs if Path has changed.
	property OnRefreshClick: TNotifyEvent read fOnRefreshClick write SetOnRefreshClick;	Occurs when the user clicks on the refresh button.
	property OnResize;	Occurs when the control is resized.
	property OpenFilesExternally: Boolean read fOpenFilesExternally write fOpenFilesExternally default True;	Influences the handling of entered file paths.
	property ParentColor default False;	Determines where a control looks for its color information.
	property ParentFont;	Specifies where a control looks for its font information.
	property Path stored NotStoreIsSpecialFolder;	The file system path of the current folder.
	property PopupMenu;	Specifies the pop-up menu associated with the control.
	property ReadOnly;	Specifies if the control can be put into edit mode by a mouse click.
	property RefreshButton: TJamShellBreadCrumbBarRefreshButton read fRefreshButton;	The refresh button next to the addressbar.
	property ReservedSpace;	Specifies the minimal amount of space, in pixels, between the last item and the combo button.
	property RootedAt: TJamShellFolder read GetRootedAt write SetRootedAt stored StoreRootedAtSpecialFolder default SF_DESKTOP;	Gets or sets the root node.
	property RootedAtFileSystemFolder: TFileName read GetRootedAtFileSystemFolder write SetRootedAtFileSystemFolder stored NotStoreRootedAtSpecialFolder;	Gets or sets the root node as filesystem folder.
	property SearchEdit: TJamShellSearchEdit read fSearchEdit;	The TJamShellSearchEdit in top right corner of the window.
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	Connects this component to a TJamShellLink in order to synchronize several shell controls.
	property ShowErrorMessages;	Allow Windows error messages.
	property ShowHidden: Boolean read GetShowHidden write SetShowHidden default False;	This property allows to hide files or folders.
	property ShowHint;	Shows hint text.
	property SpecialFolder: TJamShellFolder read GetSpecialFolder write SetSpecialFolder stored StoreIsSpecialFolder;	Allows you to deal with non file system folders.
	property Style;	Specifies the rendering style of the control.
	property StyleElements;	Specifies the style elements that are used by the control.
	property StyleName;	Specifies the style name for this control.
	property TabOrder;	Indicates the position of the control in its parent's tab order.
	property TabStop: Boolean read GetTabStop write SetTabStop default True;	Determines whether the user can tab to a control.
	property TextMargin;	Specifies the amount of space, in pixels, to the left and right of captions.
	property UseSystemFont;	Set this property to true if you want the component to utilize the default system font.
	property Version;	The current version of the ShellBrowser components.
	property Visible;	Determines whether the component appears on screen.
	property VisiblePanes: TJamShellBreadCrumbBarPanes read fVisiblePanes write SetVisiblePanes;	Gets or sets the visible panes.

Links

JamShellBreadCrumbBar, Legend, Members, Public Methods, TCustomBreadCrumbControl Events, TCustomBreadCrumbControl Methods, TCustomBreadCrumbControl Properties

Contents | Index | Home