Interface through which objects can be exposed as project parts. More...
#include <IProjectItem.h>
Public Member Functions | |
| virtual bool | closeProjectItem (ITask *task=0)=0 |
| Close the project item. | |
| virtual bool | newProjectItem ()=0 |
| Called by the project manager when a new project needs to be created. | |
| virtual QString | projectItemName () const =0 |
| The name of the project item. | |
 Public Member Functions inherited from Qtilities::Core::Interfaces::IModificationNotifier | |
| virtual bool | isModified () const =0 |
| Indicates the modification state of the object. | |
| virtual void | modificationStateChanged (bool is_modified) const =0 |
| Implement this function as a signal when implementing the object. | |
| virtual void | setModificationState (bool new_state, NotificationTargets notification_targets=NotifyListeners, bool force_notifications=false)=0 |
| Sets the modification state of the object. Returns true if it was successfull. | |
| Public Member Functions inherited from Qtilities::Core::Interfaces::IObjectBase | |
| virtual QObject * | objectBase ()=0 |
| Returns the QObject* base of the interface. | |
| virtual const QObject * | objectBase () const =0 |
| Returns a const QObject* base of the interface. | |
| QString | objectOriginID () const |
| Allows interfaces to provide some sort of source identification. | |
| void | setObjectOriginID (const QString &object_origin_id) |
| Allows setting of the object source ID of this interface implementation. | |
| Public Member Functions inherited from Qtilities::Core::Interfaces::IExportable | |
| quint32 | applicationExportVersion () const |
| Returns the application export version currently used by all your application's classes. | |
| virtual void | clearExportTask () |
| Clears the export task. | |
| IExportable * | duplicate (QString *error_msg=0, int properties_to_copy=0, ExportResultFlags *result_flags=0) const |
| Function which will create a duplicate (copy) of this object. | |
| virtual ExportResultFlags | exportBinary (QDataStream &stream) const |
| Allows exporting to a QDataStream. | |
| virtual ITask * | exportTask () const |
| Gets the task which must be used to log import/export information to. | |
| Qtilities::ExportVersion | exportVersion () const |
| Returns the export version currently used by all Qtilities classes. | |
| virtual ExportResultFlags | exportXml (QDomDocument *doc, QDomElement *object_node) const |
| Allows exporting to an XML document. A reference to the QDomElement to which the object's information must be added is provided, along with a reference to the QDomDocument. | |
| virtual ExportResultFlags | importBinary (QDataStream &stream, QList< QPointer< QObject > > &import_list) |
| Allows importing and reconstruction of the object state from information provided in a QDataStream. | |
| virtual ExportResultFlags | importXml (QDomDocument *doc, QDomElement *object_node, QList< QPointer< QObject > > &import_list) |
| Allows importing and reconstruction of data from information provided in a XML document. A reference to the QDomElement which contains the object's information is provided, along with a reference to the QDomDocument. | |
| virtual InstanceFactoryInfo | instanceFactoryInfo () const |
| The instance factory information which must be used when the exported object is reconstructed during an import. | |
| bool | isExportable () const |
| Gets if this object must be part of it's parents' exports. | |
| virtual void | setApplicationExportVersion (quint32 version) |
| Sets the application export version currently used by all your application's classes. | |
| virtual void | setExportTask (ITask *task) |
| Sets the task which must be used to log import/export information to. | |
| virtual void | setExportVersion (Qtilities::ExportVersion version) |
| Returns the export version currently used by all Qtilities classes. | |
| virtual void | setIsExportable (bool new_is_exportable) |
| Sets if this object must be part of it's parents' exports. | |
| virtual ExportModeFlags | supportedFormats () const |
| Provides information about the export format(s) supported by your implementation of IExportable. | |
Additional Inherited Members | |
| Public Types inherited from Qtilities::Core::Interfaces::IModificationNotifier | |
| enum | NotificationTarget { NotifyNone = 0, NotifyListeners = 1, NotifySubjects = 2 } |
| The targets which should be notified when the state of the object implementing this interface changes. More... | |
| Public Types inherited from Qtilities::Core::Interfaces::IExportable | |
| enum | ExportMode { None = 0, Binary = 1, XML = 2 } |
| Possible export modes that an implementation of IExportable can support. More... | |
| enum | Result { Complete = 0, Incomplete = 1, Failed = 2, FailedContinue = 4, VersionTooNew = 8, VersionTooOld = 16, VersionSupported = 32, SuccessResult = Complete | Incomplete | VersionSupported, FailedResult = Failed | FailedContinue | VersionTooNew | VersionTooOld } |
| The possible results of an export/import operation. More... | |
| Static Public Member Functions inherited from Qtilities::Core::Interfaces::IExportable | |
| template<typename T > | |
| static T * | duplicateInstance (IExportable *obj, QString *error_msg=0, int properties_to_copy=0, ExportResultFlags *result_flags=0) |
| Provides an easy to use template based implementation of IExportable::duplicate(). | |
| static QString | exportModeToString (ExportMode export_mode) |
| Function which returns a string associated with a specific ExportMode. | |
| static ExportMode | stringToExportMode (const QString &export_mode_string) |
| Function which returns the ExportMode associated with a string. | |
| static Result | validateQtilitiesExportVersion (Qtilities::ExportVersion export_version, ITask *task=0) |
| Checks the exportVersion() against the supported Qtilities export versions for the current Qtilities version. | |
| static Result | validateQtilitiesImportVersion (Qtilities::ExportVersion import_version, ITask *task=0) |
| Checks the exportVersion() against the supported Qtilities import versions for the current Qtilities version. | |
Interface through which objects can be exposed as project parts.
Project loading and saving is done through the implementation of IExportable.
| Qtilities : Reference Documentation | Back to top |
Copyright © 2009-2013, Jaco Naudé
|
