Rhino C++ API
7.26
|
#include <RhRdkDataSource.h>
Public Member Functions | |
virtual void | AddHost (IRhinoUiDataSourceHost &h)=0 |
virtual void | Commit (const UUID &uuidData, IRhinoUiEventInfo *pInfo=nullptr)=0 |
virtual void | DeleteThis (void)=0 |
virtual void | Discard (const UUID &uuidData)=0 |
virtual void * | EVF (const wchar_t *wszFunc, void *pvData)=0 |
virtual void * | GetData (const UUID &uuidData, bool bForWrite, bool bAutoChangeBracket=true) const =0 |
virtual void | RegisterEventWatcher (IRhinoUiDataSourceEventWatcher &ew)=0 |
virtual void | RemoveHost (IRhinoUiDataSourceHost &h)=0 |
virtual bool | ResetToDefaults (void)=0 |
virtual bool | SetChanged (void)=0 |
virtual void | UnregisterEventWatcher (IRhinoUiDataSourceEventWatcher &ew)=0 |
Protected Member Functions | |
virtual | ~IRhinoUiDataSource () |
Data source for user interfaces. A UI can have any number of data sources.
|
inlineprotectedvirtual |
|
pure virtual |
Called when the data source is added to a data source host.
Implemented in CRhRdkDataSource.
|
pure virtual |
Commit changes made using GetData() with bForWrite=true.
uuidData | is the identifier of the data. |
pInfo | is a pointer to optional info to be sent with any event that is raised. Events will be sent for any data objects that have had data committed. Every call to GetData() with bForWrite=true must be matched by a call to either Commit() or Discard(). This method should not be called if the operation is cancelled. Instead you should call Discard(). |
Implemented in CRhRdkSimpleSunDataSource, and CRhRdkDataSource.
|
pure virtual |
|
pure virtual |
Discard changes made using GetData() with bForWrite=true.
uuidData | is the identifier of the data. Every call to GetData() with bForWrite=true must be matched by a call to either Commit() or Discard(). This method should only be called if the operation is cancelled. Otherwise you should call Commit(). |
Implemented in CRhRdkDataSource, and CRhRdkSimpleSunDataSource.
|
pure virtual |
Emergency virtual function for future expansion.
Implemented in CRhRdkDataSource.
|
pure virtual |
Get data specified by a unique id.
uuidData | is the identifier of the data. UUIDs defined by Rhino are specified above. |
bForWrite | specifies if you intend to write to the data. |
bAutoChangeBracket | is if you want BeginChange() and EndChange() to be called automatically when the data is contents. |
Implemented in CRhRdkSimpleSunDataSource.
|
pure virtual |
Add a data source host which would like to be notified of events that affect its data. When such an event arrives, the data source checks if the host is interested in the event and if so, it calls the host's OnEvent() method.
Implemented in CRhRdkDataSource.
|
pure virtual |
Called by a data source host when it is being deleted.
Implemented in CRhRdkDataSource.
|
pure virtual |
Implement this method to reset all data to defaults, if possible.
Implemented in CRhRdkSimpleSunDataSource, and CRhRdkDataSource.
|
pure virtual |
Set the data source as changed. This must be called in between GetData() with bForWrite == true and Commit() in order for the commit to succeed and an event to be sent. If it is called when the data source is not in write mode, the call will fail.
Implemented in CRhRdkDataSource.
|
pure virtual |
Remove a data source host which has been added by RegisterEventWatcher(). This must be done when such a host is deleted.
Implemented in CRhRdkDataSource.