ContentPresentationView.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/ContentPresentationView.h#2 $
00020 //  $DateTime: 2008/06/18 18:08:14 $
00021 //  $Author: gaoje $
00022 //  $Change: 101166 $
00023 
00024 #ifndef _DWFTK_CONTENT_PRESENTATION_VIEW_H
00025 #define _DWFTK_CONTENT_PRESENTATION_VIEW_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/presentation/ContentPresentationNode.h"
00040 #include "dwf/presentation/utility/PropertyReferenceContainer.h"
00041 #include "dwf/presentation/utility/ContentPresentationNodeContainer.h"
00042 
00043 namespace DWFToolkit
00044 {
00045 
00046 //
00047 // fwd declarations
00048 //
00049 class DWFContentPresentationViewContainer;
00050 
00060 
00061 class DWFContentPresentationView : public DWFPropertyReferenceContainer
00062                                  , public DWFContentPresentationNodeContainer
00063                                  , public DWFXMLBuildable
00064 #ifndef DWFTK_READ_ONLY
00065                                  , public DWFXMLSerializable
00066 #endif
00067                                    _DWFTK_EXPORT_API_MEMORY_CONTROL_BASE_MEMBER
00068 {
00069     friend class DWFContentPresentationViewContainer;
00070 
00071 public:
00075     typedef DWFOrderedVector<DWFContentPresentationView*>            tList;
00079     typedef DWFStringKeySkipList<DWFContentPresentationView*>         tMap;
00080 
00081 public:
00082 
00090     _DWFTK_API
00091     DWFContentPresentationView( const DWFString& zLabel = /*NOXLATE*/L"",
00092                                 const DWFString& zID = /*NOXLATE*/L"" )
00093         throw();
00100     _DWFTK_API
00101     virtual ~DWFContentPresentationView()
00102         throw();
00103 
00110     _DWFTK_API
00111     virtual void setID( const DWFString& zID )
00112         throw( DWFException );
00113 
00121     _DWFTK_API
00122     virtual const DWFString& id() const
00123         throw();
00124 
00131     _DWFTK_API
00132     virtual void setLabel( const DWFString& zLabel )
00133         throw();
00134 
00142     _DWFTK_API
00143     virtual const DWFString& label() const
00144         throw();
00145 
00155     _DWFTK_API
00156     virtual void setPropertySetID( const DWFString& zPropertySetID,
00157                                    bool             bUseDefaultIfNotFound = true )
00158         throw( DWFException );
00159 
00166     _DWFTK_API
00167     virtual const DWFString& propertySetID() const
00168         throw();
00169 
00178     _DWFTK_API
00179     virtual void setPropertySchemaID( const DWFString& zPropertySchemaID,
00180                                       bool             bUseDefaultIfNotFound = false )
00181         throw( DWFException );
00182 
00189     _DWFTK_API
00190     virtual const DWFString& propertySchemaID() const
00191         throw();
00192 
00201     _DWFTK_API
00202     virtual bool useDefaultPropertyIfNotFoundInSet() const
00203         throw()
00204     {
00205         return _bUseDefaultIfNotFound;
00206     }
00207 
00214     _DWFTK_API
00215     virtual void setHidden( bool bHidden )
00216         throw()
00217     {
00218         _bHidden = bHidden;
00219     }
00220 
00227     _DWFTK_API
00228     virtual bool hidden() const
00229         throw()
00230     {
00231         return _bHidden;
00232     }
00233 
00240     _DWFTK_API
00241     virtual DWFContentPresentationViewContainer* parent() const
00242         throw()
00243     {
00244         return _pParent;
00245     }
00246 
00250     _DWFTK_API
00251     virtual void parseAttributeList( const char** ppAttributeList )
00252         throw( DWFException );
00253 
00254 #ifndef DWFTK_READ_ONLY
00255 
00259     _DWFTK_API
00260     virtual void serializeXML( DWFXMLSerializer& rSerializer, unsigned int nFlags )
00261         throw( DWFException );
00262 
00263 #endif
00264 
00265 private:
00266 
00267     DWFContentPresentationView( const DWFContentPresentationView& );
00268     DWFContentPresentationView& operator=( const DWFContentPresentationView& );
00269 
00270     void setParent( DWFContentPresentationViewContainer* pParent )
00271     {
00272         _pParent = pParent;
00273     }
00274 
00275 private:
00276 
00277     DWFString                               _zID;
00278     DWFString                               _zLabel;
00279     DWFString                               _zPropertySetID;
00280     DWFString                               _zPropertySchemaID;
00281     bool                                    _bUseDefaultIfNotFound;
00282     bool                                    _bHidden;
00283     DWFContentPresentationViewContainer*    _pParent;
00284 };
00285 
00286 }
00287 
00288 #endif
00289 

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