Logged out, click to login

JEDI Online help - Browsing a unit



Back to project JVCL Back Add an item Edit unit Generate DTX file Search Administration

Unit JvDataProviderIntf.pas

Author: Marcel Bestebroer, Remko Bonte, Peter Thörnqvist

Package: Core

Status: Completed (II)

Contains the interface declarations of the DataProvider mechanism. <INCLUDE JVCL.UnitText.dtx>

Last changed by obones on 2009-01-04 21:13:49 CET

Items in the unit

Item
Summary
EJVCLDataConsumer Exception class for errors relating to the IJvDataConsumer interface.
EJVCLDataContexts Exception class for errors relating to the IJvDataContext or IJvDataContexts interfaces.
EJVCLDataItems Exception class for errors relating to the IJvDataItem or IJvDataItems interfaces.
EJVCLDataProvider Exception class for errors relating to the IJvDataProvider interface.
IJvDataConsumer Provider client interface.
IJvDataConsumer.AttributeApplies Determines if an attribute applies to the consumer.
IJvDataConsumer.VCLComponent Retrieves a reference to the VCL component.
IJvDataConsumerClientNotify Data consumer support interface to be notified when another consumer changes item.
IJvDataConsumerClientNotify.ItemSelected Called when the server consumer selects another item.
IJvDataConsumerClientNotify.LinkAdded Called when the server consumer has added the client to its list of clients.
IJvDataConsumerClientNotify.LinkRemoved Called when the server consumer has removed the client from its list of clients.
IJvDataConsumerContext Data consumer support interface to retrieve the selected context.
IJvDataConsumerContext.GetContext Determine the current context for this consumer.
IJvDataConsumerContext.SetContext Specify a new context for this consumer.
IJvDataConsumerItemSelect Data consumer support interface to determine the displayed (root) item.
IJvDataConsumerItemSelect.GetItem Determine the current (root) item.
IJvDataConsumerItemSelect.SetItem Specify a new (root) item.
IJvDataConsumerItemState Data consumer support interface to determine item states at the consumer side.
IJvDataConsumerItemState.Checked Determines if the item is checked.
IJvDataConsumerItemState.Enabled Determines if the item is enabled.
IJvDataConsumerItemState.Visible Determines if the item is visible.
IJvDataConsumerProvider Data consumer support interface to retrieve the selected provider.
IJvDataConsumerProvider.GetProvider The provider the consumer is linked to.
IJvDataConsumerServerNotify Data consumer support interface to notify another consumer when the current item changes.
IJvDataConsumerServerNotify.AddClient Add a client to the list.
IJvDataConsumerServerNotify.IsValidClient Checks if the client is a valid client to be linked to the server.
IJvDataConsumerServerNotify.NotifyProviderChanged Called by the client when it has changed provider or other setting that may influence the validity.
IJvDataConsumerServerNotify.RemoveClient Remove a client.
IJvDataConsumerViewList Data consumer support interface to manager the tree of data items in a flat list.
IJvDataConsumerViewList.AutoExpandLevel Specifies to which level the tree will be expanded automatically.
IJvDataConsumerViewList.ChildIndexOfID Locates an item by ID and return its index within its parents list in the view list.
IJvDataConsumerViewList.ChildIndexOfItem Locates an item and return its index within its parents list in the view list.
IJvDataConsumerViewList.Count Determine the number of items in the view list.
IJvDataConsumerViewList.ExpandOnNewItem Specify if the view should expand the tree when a new item is added.
IJvDataConsumerViewList.ExpandTreeTo Expands the view list so that the specified item is visible.
IJvDataConsumerViewList.get_AutoExpandLevel Retrieves the level to which the tree will be expanded automatically.
IJvDataConsumerViewList.get_ExpandOnNewItem Returns the flag to indicate if the view should expand the tree when a new item is added.
IJvDataConsumerViewList.get_LevelIndent Returns the indentation to use for each level.
IJvDataConsumerViewList.IndexOfID Locates an item by ID and return its index in the view list.
IJvDataConsumerViewList.IndexOfItem Locates an item and return its index in the view list.
IJvDataConsumerViewList.Item Retrieve a reference to a Data Item.
IJvDataConsumerViewList.ItemGroupInfo Determine grouping information for an item.
IJvDataConsumerViewList.ItemHasChildren Determines if an item has children.
IJvDataConsumerViewList.ItemIsExpanded Determines if an item is expanded.
IJvDataConsumerViewList.ItemLevel Determines the tree level of an item.
IJvDataConsumerViewList.ItemParent Retrieves a reference to the parent item of an item.
IJvDataConsumerViewList.ItemParentIndex Determines the index in the view list for the parent item of an item.
IJvDataConsumerViewList.ItemSibling Retrieves a reference to the next sibling of an item.
IJvDataConsumerViewList.ItemSiblingIndex Determines the index in the view list for the next sibling of an item.
IJvDataConsumerViewList.LevelIndent Indentation to use for each level.
IJvDataConsumerViewList.RebuildView Rebuilds the view of the tree for the consumer.
IJvDataConsumerViewList.set_AutoExpandLevel Sets the level to which the tree will be expanded automatically.
IJvDataConsumerViewList.set_ExpandOnNewItem Sets the flag to indicate if the view should expand the tree when a new item is added.
IJvDataConsumerViewList.set_LevelIndent Sets the indentation to use for each level.
IJvDataConsumerViewList.SubItem

@IJvDataItem

@Integer
Retrieve a reference to a child item of a given item.
IJvDataConsumerViewList.SubItem

@Integer

@Integer
Retrieve a reference to a child item of a given item.
IJvDataConsumerViewList.SubItemIndex

@IJvDataItem

@Integer
Retrieve the index to a child item of a given item.
IJvDataConsumerViewList.SubItemIndex

@Integer

@Integer
Retrieve the index to a child item of a given item.
IJvDataConsumerViewList.ToggleItem Toggles the expanded state of an item.
IJvDataContext Context object.
IJvDataContext.Contexts Reference to the context list.
IJvDataContext.GetImplementer Retrieves the TObject implementing object.
IJvDataContext.IsDeletable Determines if the context can be deleted.
IJvDataContext.Name The name of the context.
IJvDataContextManager \IJvDataContext support interface to change context name.
IJvDataContextManager.SetName Change the name of the context.
IJvDataContexts List of \IJvDataContext objects.
IJvDataContexts.Ancestor Retrieve a reference to the ancestor context.
IJvDataContexts.GetContext Retrieve the context specified by its index.
IJvDataContexts.GetContextByName Retrieve the context specified by the name.
IJvDataContexts.GetCount Retrieve the number of contexts the list holds.
IJvDataContexts.IndexOf Determine the index of a context.
IJvDataContexts.Provider Reference to the provider the list belongs to.
IJvDataContextSensitive Context sensitive data manager.
IJvDataContextSensitive.IsEqualToAncestor Determines if the settings are inherited from the ancestor context.
IJvDataContextSensitive.RevertToAncestor Reverts the settings back to the ancestor context settings.
IJvDataContextsManager Support interface for IJvDataContexts that handles context management.
IJvDataContextsManager.Add Adds a context to the list.
IJvDataContextsManager.Clear Empties the list of contexts.
IJvDataContextsManager.Delete Removes a context from the list.
IJvDataContextsManager.New Creates a new data context and adds it to the list.
IJvDataIDSearch Find an item using its ID.
IJvDataIDSearch.Find Locate an item.
IJvDataItem Single Data Item.
IJvDataItem.ContextDestroying Called when a context is about to be destroyed.
IJvDataItem.GetID Retrieves the ID value of the Data Item.
IJvDataItem.GetImplementer Reference to the implementing object.
IJvDataItem.GetIndex Retrieves the item's index in the owning list.
IJvDataItem.GetItems Retrieves the reference to the IJvDataItems owner of this item.
IJvDataItem.Implementer Reference to the implementing object.
IJvDataItem.IsDeletable Determines if the item may be removed from the list.
IJvDataItem.IsParentOf Determines if the item is an ancestor of another item.
IJvDataItem.Items Reference to the items list owner of this item.
IJvDataItemBasicAction Data Item support interface for responding to an item being selected/double clicked.
IJvDataItemBasicAction.Execute Performs a task linked to the item.
IJvDataItemColumn Write here a summary (1 line)
IJvDataItemColumn.Header Write here a summary (1 line)
IJvDataItemColumns Write here a summary (1 line)
IJvDataItemColumns.GetColumnByID Write here a summary (1 line)
IJvDataItemColumns.GetColumnFor Write here a summary (1 line)
IJvDataItemDesigner Data Item support interface to allow editing of an item in the design time provider editor.
IJvDataItemDesigner.ExecVerb Executes a particular edit action on the item.
IJvDataItemDesigner.GetVerb Retrieve information on a particular edit action for the item.
IJvDataItemDesigner.GetVerbCount Returns the number of edit actions available for the item.
IJvDataItemImage Data Item support interface for adding image support to an item.
IJvDataItemImage.Alignment Specifies the position of the image.
IJvDataItemImage.GetAlignment Retrieves the position of the image
IJvDataItemImage.GetImageIndex Retrieves the index into the image list of the image to render.
IJvDataItemImage.GetSelectedIndex Retrieves the index into the image list of the image to render when the item is selected.
IJvDataItemImage.ImageIndex Specifies the index into the image list of the image to render.
IJvDataItemImage.SelectedIndex Specifies the index into the image list of the image to render when the item is selected.
IJvDataItemImage.SetAlignment Sets the position of the image
IJvDataItemImage.SetImageIndex Sets the index into the image list of the image to render.
IJvDataItemImage.SetSelectedIndex Sets the index into the image list of the image to render when the item is selected.
IJvDataItemRenderer Data Item support interface that handles rendering and measuring itself.
IJvDataItemRenderer.Draw Draw an item.
IJvDataItemRenderer.Measure Measure an item.
IJvDataItems List of IJvDataItem objects.
IJvDataItems.ContextDestroying Called when a context is about to be destroyed.
IJvDataItems.Count Number of items in the list.
IJvDataItems.GetCount Retrieves the number of items in the list.
IJvDataItems.GetImplementer Reference to the implementing object.
IJvDataItems.GetItem Retrieve an item from the list.
IJvDataItems.GetItemByID Retrieve an item from the list given its ID (or ID path).
IJvDataItems.GetItemByIndexPath Retrieve an item from the list given its index path.
IJvDataItems.GetParent Reference to the parent item.
IJvDataItems.GetProvider Reference to the data provider instance.
IJvDataItems.IsDynamic Determines if the items are dynamic.
IJvDataItems.Items Array of list items.
IJvDataItems.Parent Reference to the parent item.
IJvDataItems.Provider Reference to the data provider instance.
IJvDataItemsDesigner Support interface for IJvDataItems that handles item design at the item list level.
IJvDataItemsDesigner.GetCount Returns the number of item kinds.
IJvDataItemsDesigner.GetKind Retrieve the menu caption for an item kind.
IJvDataItemsDesigner.NewByKind Creates a specific type of Data Item.
IJvDataItemsImages Support interface for IJvDataItems to specify image lists for the items.
IJvDataItemsImages.DisabledImages \Get or set the image list to use for disabled items.
IJvDataItemsImages.GetDisabledImages Retrieves the image list for disabled items.
IJvDataItemsImages.GetHotImages Retrieves the image list for "hot" items.
IJvDataItemsImages.GetImages Retrieves the image list for normal items.
IJvDataItemsImages.HotImages \Get or set the image list to use for "hot" items.
IJvDataItemsImages.Images Get or set the image list to use for normal items.
IJvDataItemsImages.SetDisabledImages Specifies the image list for disabled items.
IJvDataItemsImages.SetHotImages Specifies the image list for "hot" items.
IJvDataItemsImages.SetImages Specifies the image list for normal items.
IJvDataItemsManagement Support interface for IJvDataItems that handles item management.
IJvDataItemsManagement.Add Add an item to the list.
IJvDataItemsManagement.Clear Empties the list of items.
IJvDataItemsManagement.Delete Delete an item given an index.
IJvDataItemsManagement.New Create and add a new item to the list.
IJvDataItemsManagement.Remove Delete an item given its reference.
IJvDataItemsRenderer Support interface for IJvDataItems that handles rendering and measuring of its items and their sub items.
IJvDataItemsRenderer.AvgItemSize Determines the average item size.
IJvDataItemsRenderer.DrawItem Draw an item.
IJvDataItemsRenderer.DrawItemByIndex Draw an item given its index.
IJvDataItemsRenderer.MeasureItem Measure an item.
IJvDataItemsRenderer.MeasureItemByIndex Measure an item given its index.
IJvDataItemStates Data Item support interface for keeping item states at the provider side.
IJvDataItemStates.Checked Specifies if the item is checked.
IJvDataItemStates.Enabled Specifies if the item is enabled.
IJvDataItemStates.get_Checked Retrieves the checked state.
IJvDataItemStates.get_Enabled Retrieves the enabled state.
IJvDataItemStates.get_Visible Retrieves the visible state.
IJvDataItemStates.set_Checked Sets the checked state.
IJvDataItemStates.set_Enabled Sets the enabled state.
IJvDataItemStates.set_Visible Sets the visible state.
IJvDataItemStates.Visible Specifies if the item is visible.
IJvDataItemText Data Item support interface for retrieving the item's textual representation.
IJvDataItemText.Editable Specifies if the text of the item or column is editable.
IJvDataItemText.GetText Retrieves the text of the data item or column.
IJvDataItemText.SetText Sets a new text for the data item or column.
IJvDataItemText.Text Specifies the caption of the data item.
IJvDataProvider Data Provider server interface.
IJvDataProvider.AllowContextManager Specifies if the provider allows its contexts to be managed at design time.
IJvDataProvider.AllowProviderDesigner Specifies if the provider allows its tree to be designed at design time.
IJvDataProvider.Changed Will notify all registered notifiers a change has occurred.
IJvDataProvider.Changing Will notify all registered notifiers a change is about to occur.
IJvDataProvider.ConsumerClasses Retrieves a list of consumer service extension classes needed by the provider.
IJvDataProvider.ConsumerDestroying Called when a consumer is about to be destroyed.
IJvDataProvider.ContextDestroying Called when a context is about to be destroyed.
IJvDataProvider.GetImplementer Reference to the implementing object.
IJvDataProvider.GetItems Retrieves the list of root items.
IJvDataProvider.GetNotifier Retrieves a reference to a registered notifier.
IJvDataProvider.GetNotifierCount Retrieve the number of registered notifiers.
IJvDataProvider.RegisterChangeNotify Register a change notification callback interface.
IJvDataProvider.ReleaseConsumer Deselects the current consumer, reselecting any previous selected consumer.
IJvDataProvider.ReleaseContext Deselects the current context, reselecting any previous selected context.
IJvDataProvider.SelectConsumer Selects a new consumer.
IJvDataProvider.SelectContext Selects a new context.
IJvDataProvider.SelectedConsumer Returns the last selected (currently active) consumer.
IJvDataProvider.SelectedContext Returns the last selected (currently active) context.
IJvDataProvider.UnregisterChangeNotify Unregister a change notification callback interface.
IJvDataProviderColumn Write here a summary (1 line)
IJvDataProviderColumn.Caption Write here a summary (1 line)
IJvDataProviderColumn.GetCaption Write here a summary (1 line)
IJvDataProviderColumn.GetID Write here a summary (1 line)
IJvDataProviderColumn.SetCaption Write here a summary (1 line)
IJvDataProviderColumns Write here a summary (1 line)
IJvDataProviderColumns.Columns Write here a summary (1 line)
IJvDataProviderColumns.Count Write here a summary (1 line)
IJvDataProviderColumns.GetColumn Write here a summary (1 line)
IJvDataProviderColumns.GetColumnByID Write here a summary (1 line)
IJvDataProviderColumns.GetCount Write here a summary (1 line)
IJvDataProviderColumnsManager Write here a summary (1 line)
IJvDataProviderColumnsManager.Add Write here a summary (1 line)
IJvDataProviderColumnsManager.AddID Write here a summary (1 line)
IJvDataProviderColumnsManager.Clear Write here a summary (1 line)
IJvDataProviderColumnsManager.Remove Write here a summary (1 line)
IJvDataProviderColumnsManager.RemoveAt Write here a summary (1 line)
IJvDataProviderNotify Callback interface to respond to changes at the provider.
IJvDataProviderNotify.Consumer Reference to the consumer belonging to this callback.
IJvDataProviderNotify.DataProviderChanged Called when a change has occurred at the provider.
IJvDataProviderNotify.DataProviderChanging Called when a change is about to occur at the provider.
IJvDataTextSearch Find an item using its associated text.
IJvDataTextSearch.Find Locate an item.
TClassArray Dynamic TClass array.
TDataItemState Type used to specify the state of a Data Item.
TDataItemState.disFalse Specifies the setting is False or 'off'.
TDataItemState.disIndetermined Specifies the setting is 'indetermined' (neither False/off nor True/on).
TDataItemState.disNotUsed Specifies the setting is not used by this item.
TDataItemState.disTrue Specifies the setting is True or 'on'.
TDataProviderChangeReason Type used to specify the change reason.
TDataProviderChangeReason.pcrAdd An item is about to be added or has just been added. The Source parameter will refer to the
TDataProviderChangeReason.pcrContextAdd A context is about to be added or has just been added. Source refers to the context the new context is added to (or nil if the context is added at the root) or the context that has just been added.
TDataProviderChangeReason.pcrContextDelete A context is about to be deleted or has just been deleted. Source refers to the context about to be deleted or the context where a context has just been removed from (or nil if a context at the root was deleted).
TDataProviderChangeReason.pcrContextUpdate A context is about to be changed or has just been changed. Source refers to the context changing or changed. It usually signals the context name is changing or has changed.
TDataProviderChangeReason.pcrDelete An item is about to be deleted or has just been deleted. The Source parameter will refer to the
TDataProviderChangeReason.pcrDestroy The IJvDataProvider is destroying. This reason will only occur in the DataProviderChanging notification.
TDataProviderChangeReason.pcrFullRefresh The consumer should execute a full refresh (changes are made or being made that affect the entire data tree, including tree structure).
TDataProviderChangeReason.pcrUpdateItem An item is about to be changed or has just been changed. The Source parameter will refer to the
TDataProviderChangeReason.pcrUpdateItems An item list is about to be changed or has just been changed. The Source parameter will refer to the
TJvDataContextID Type used to link the context selection editor to.
TJvDataItemID Type used to link the item selection editor to.
TProviderDrawState Type used to specify the draw state for the provider based rendering mechanism.
TProviderDrawState.pdsChecked The item is checked.
TProviderDrawState.pdsDefault The item is the default item.
TProviderDrawState.pdsDisabled The item is disabled.
TProviderDrawState.pdsFocused The item has the focus.
TProviderDrawState.pdsGrayed The item is grayed out.
TProviderDrawState.pdsHot The item is hot (i.e. the mouse is hovering over it).
TProviderDrawState.pdsSelected The item is currently selected.
TProviderDrawStates Type used to specify the draw state for the provider based rendering mechanism.

Copyright (c) 2004 by the JVCL Team; all rights reserved
Uses PclZip by phpconcept and parts of the PEAR library