PropertyReference.h

Go to the documentation of this file.
00001 //
00002 //  Copyright (c) 2006 by Autodesk, Inc.
00003 //
00004 //  By using this code, you are agreeing to the terms and conditions of
00005 //  the License Agreement included in the documentation for this code.
00006 //
00007 //  AUTODESK MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO THE CORRECTNESS
00008 //  OF THIS CODE OR ANY DERIVATIVE WORKS WHICH INCORPORATE IT. AUTODESK
00009 //  PROVIDES THE CODE ON AN "AS-IS" BASIS AND EXPLICITLY DISCLAIMS ANY
00010 //  LIABILITY, INCLUDING CONSEQUENTIAL AND INCIDENTAL DAMAGES FOR ERRORS,
00011 //  OMISSIONS, AND OTHER PROBLEMS IN THE CODE.
00012 //
00013 //  Use, duplication, or disclosure by the U.S. Government is subject to
00014 //  restrictions set forth in FAR 52.227-19 (Commercial Computer Software
00015 //  Restricted Rights) and DFAR 252.227-7013(c)(1)(ii) (Rights in Technical
00016 //  Data and Computer Software), as applicable.
00017 //
00018 
00019 //  $Header: //DWF/Development/Components/Internal/DWF Toolkit/v7.6/develop/global/src/dwf/presentation/PropertyReference.h#2 $
00020 //  $DateTime: 2008/06/18 18:08:14 $
00021 //  $Author: gaoje $
00022 //  $Change: 101166 $
00023 
00024 #ifndef _DWFTK_PROPERTY_REFERENCE_H
00025 #define _DWFTK_PROPERTY_REFERENCE_H
00026 
00027 
00032 
00033 #include "dwfcore/STL.h"
00034 #include "dwfcore/DWFXMLSerializer.h"
00035 #include "dwfcore/Vector.h"
00036 using namespace DWFCore;
00037 
00038 #include "dwf/Toolkit.h"
00039 #include "dwf/package/XML.h"
00040 
00041 namespace DWFToolkit
00042 {
00043 
00053 
00054 class DWFPropertyReference
00055                             : public DWFXMLBuildable
00056 #ifndef DWFTK_READ_ONLY
00057                             , public DWFXMLSerializable
00058 #endif
00059                             _DWFTK_EXPORT_API_MEMORY_CONTROL_BASE_MEMBER
00060 {
00061 
00062 public:
00066     typedef DWFOrderedVector<DWFPropertyReference*>            tList;
00067 
00068 public:
00069 
00076     _DWFTK_API
00077     DWFPropertyReference( const DWFString& zID = /*NOXLATE*/L"" )
00078         throw();
00085     _DWFTK_API
00086     virtual ~DWFPropertyReference()
00087         throw();
00088 
00089 
00096     _DWFTK_API
00097     virtual void setID( const DWFString& zID )
00098         throw()
00099     {
00100         _zID = zID;
00101     }
00102 
00109     _DWFTK_API
00110     virtual const DWFString& id() const
00111         throw()
00112     {
00113         return _zID;
00114     }
00115 
00121     //          
00132     _DWFTK_API
00133     virtual void setReference( const DWFString& zName,
00134                                const DWFString& zCategory = /*NOXLATE*/L"",
00135                                const DWFString& zLabel = /*NOXLATE*/L"" )
00136         throw( DWFException );
00153     _DWFTK_API
00154     virtual void setReferenceWithSetID( const DWFString& zPropertySetID,
00155                                         const DWFString& zName,
00156                                         const DWFString& zCategory = /*NOXLATE*/L"",
00157                                         const DWFString& zLabel = /*NOXLATE*/L"" )
00158         throw( DWFException );
00159 
00176     _DWFTK_API
00177     virtual void setReferenceWithSchemaID( const DWFString& zPropertySchemaID,
00178                                            const DWFString& zName,
00179                                            const DWFString& zCategory = /*NOXLATE*/L"",                                           
00180                                            const DWFString& zLabel = /*NOXLATE*/L"" )
00181         throw( DWFException );
00188     _DWFTK_API
00189     virtual const DWFString& name() const
00190         throw()
00191     {
00192         return _zName;
00193     }
00194 
00200     //          
00203     _DWFTK_API
00204     virtual const DWFString& category() const
00205         throw()
00206     {
00207         return _zCategory;
00208     }
00209 
00219     _DWFTK_API
00220     virtual const DWFString& propertySetID() const
00221         throw()
00222     {
00223         return _zPropertySetID;
00224     }
00225 
00235     _DWFTK_API
00236     virtual const DWFString& propertySchemaID() const
00237         throw()
00238     {
00239         return _zPropertySchemaID;
00240     }
00241 
00249     _DWFTK_API
00250     virtual const DWFString& label() const
00251         throw()
00252     {
00253         return _zLabel;
00254     }
00255 
00259     _DWFTK_API
00260     virtual void parseAttributeList( const char** ppAttributeList )
00261         throw( DWFException );
00262 
00263 #ifndef DWFTK_READ_ONLY
00264 
00268     _DWFTK_API
00269     virtual void serializeXML( DWFXMLSerializer& rSerializer, unsigned int nFlags )
00270         throw( DWFException );
00271 
00272 #endif
00273 
00274 private:
00275 
00276     DWFString                         _zID;
00277     DWFString                         _zName;
00278     DWFString                         _zCategory;
00279     DWFString                         _zPropertySetID;
00280     DWFString                         _zPropertySchemaID;
00281     DWFString                         _zLabel;
00282 };
00283 
00284 }
00285 
00286 #endif

Generated on Tue Jan 6 22:40:05 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5