All Classes Namespaces Functions Variables Enumerations Enumerator Properties
plyCommonEditor.plyDataProviderInfo Class Reference

This is the editor side of the Data Provider. This class gets created when it is needed by the data provider editor. More...

Inherited by DiaQEditor.DiaQDataProviderInfo, and plyBloxKitEditor.plyBloxDataProviderInfo.

Public Member Functions

virtual string ProviderName ()
 Unique name to identify the provider by More...
 
virtual string ProviderContext ()
 Context is important to identify where this provider can be used. The default is "data", meaning it can provider data and is able to set its data. That is, it implements DataProvider_GetValue and DataProvider_SetValue. Where a system, using DataProviders, are more specialised it will indicate what context it expects if it do not function purely on get/set of data. More...
 
virtual string PrettyName (plyDataObject data, string emptyText)
 Return a nice name that identifies the data. Shown in the button used to open the data provider editor window for setup. More...
 
string PrettyName (plyDataObject data)
 emptyText = "-select-" More...
 
virtual
plyDataObject.TargetObjectType 
DefaultTargetType ()
 Init the target type with this when the provider is selected More...
 
virtual string DefaultTargetTypeData ()
 Init the target type data this when the provider is selected More...
 
virtual string DefaultComponent ()
 Init the component name with this when the provider is selected. It is the component that implements plyDataProviderInterface More...
 
virtual string[] InitNfo ()
 Init the the nfo[] field with this when the provider is selected More...
 
virtual bool CanChangeType ()
 Return true if user may choose different settings for type and type data in editor More...
 
virtual void NfoFieldFocus (plyDataObject data, EditorWindow ed)
 Called when the data provider is selected More...
 
virtual void NfoField (plyDataObject data, EditorWindow ed)
 Called when the nfo[] edit fields should be rendered More...
 

Detailed Description

This is the editor side of the Data Provider. This class gets created when it is needed by the data provider editor.

Member Function Documentation

virtual bool plyCommonEditor.plyDataProviderInfo.CanChangeType ( )
virtual

Return true if user may choose different settings for type and type data in editor

virtual string plyCommonEditor.plyDataProviderInfo.DefaultComponent ( )
virtual

Init the component name with this when the provider is selected. It is the component that implements plyDataProviderInterface

virtual plyDataObject.TargetObjectType plyCommonEditor.plyDataProviderInfo.DefaultTargetType ( )
virtual

Init the target type with this when the provider is selected

virtual string plyCommonEditor.plyDataProviderInfo.DefaultTargetTypeData ( )
virtual

Init the target type data this when the provider is selected

virtual string [] plyCommonEditor.plyDataProviderInfo.InitNfo ( )
virtual

Init the the nfo[] field with this when the provider is selected

virtual void plyCommonEditor.plyDataProviderInfo.NfoField ( plyDataObject  data,
EditorWindow  ed 
)
virtual

Called when the nfo[] edit fields should be rendered

virtual void plyCommonEditor.plyDataProviderInfo.NfoFieldFocus ( plyDataObject  data,
EditorWindow  ed 
)
virtual

Called when the data provider is selected

virtual string plyCommonEditor.plyDataProviderInfo.PrettyName ( plyDataObject  data,
string  emptyText 
)
virtual

Return a nice name that identifies the data. Shown in the button used to open the data provider editor window for setup.

string plyCommonEditor.plyDataProviderInfo.PrettyName ( plyDataObject  data)

emptyText = "-select-"

virtual string plyCommonEditor.plyDataProviderInfo.ProviderContext ( )
virtual

Context is important to identify where this provider can be used. The default is "data", meaning it can provider data and is able to set its data. That is, it implements DataProvider_GetValue and DataProvider_SetValue. Where a system, using DataProviders, are more specialised it will indicate what context it expects if it do not function purely on get/set of data.

virtual string plyCommonEditor.plyDataProviderInfo.ProviderName ( )
virtual

Unique name to identify the provider by