DWFToolkit::DWFContentPresentation Class Reference

Inheritance diagram for DWFToolkit::DWFContentPresentation:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFContentPresentation:

Collaboration graph
[legend]
List of all members.

Detailed Description

Content presentations are publisher defined means of allowing access to meta data (content) published in a dwf.

Since:
7.2
Content presentations are publisher defined means of allowing access to meta data (content) published in a dwf. Pre-defined ids can be used to publish "known" presentations.

Definition at line 55 of file ContentPresentation.h.

Public Types

typedef DWFOrderedVector<
DWFContentPresentation * > 
tList
 This type defines a list of DWFContentPresentation pointers.

Public Member Functions

_DWFTK_API DWFContentPresentation (const DWFString &zLabel=L"", const DWFString &zID=L"") throw ()
virtual _DWFTK_API ~DWFContentPresentation () throw ()
virtual _DWFTK_API void setID (const DWFString &zID) throw ( DWFException )
virtual _DWFTK_API const DWFStringid () const throw ()
virtual _DWFTK_API void setLabel (const DWFString &zLabel) throw ()
virtual _DWFTK_API const DWFStringlabel () const throw ()
virtual _DWFTK_API DWFContentPresentationContainerparent () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Static Public Attributes

static const char *const kzID_PackageContents
 Pre-defined ID for package contents presentation.
static const char *const kzID_ContentNavigation
 Pre-defined ID for content navigation presentation.
static const char *const kzID_Views
 Pre-defined ID for views presentation.
static const char *const kzID_DefinedViews
static const char *const kzID_Layers
 Pre-defined ID for layers presentation.
static const char *const kzID_Table
 Pre-defined ID for tabular presentation.
static const char *const kzID_Animations
 Pre-defined ID for animation presentation.
static const char *const kzID_Showmotions
 Pre-defined ID for animation presentation.

Friends

class DWFContentPresentationContainer


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFContentPresentation::DWFContentPresentation const DWFString zLabel = L"",
const DWFString zID = L""
throw ()
 

Constructor

Parameters:
zID An optional identifier used when referencing this presentation.
zLabel An optional user-friendly label for this presentation.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFContentPresentation::~DWFContentPresentation  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentation::id  )  const throw () [virtual]
 

Returns the ID for this presentation If no label has been set, returns the null string

Returns:
The label for this presentation
Exceptions:
None 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentation::label  )  const throw () [virtual]
 

Returns the label for this presentation If no label has been set, returns the null string

Returns:
The label for this presentation
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationContainer* DWFToolkit::DWFContentPresentation::parent  )  const throw () [inline, virtual]
 

Returns the parent of this presentation - the container which holds it.

Returns:
The parent, or NULL if one has not yet been set.
Exceptions:
None 

Definition at line 174 of file ContentPresentation.h.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentation::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLBuildable.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentation::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLSerializableBase.

virtual _DWFTK_API void DWFToolkit::DWFContentPresentation::setID const DWFString zID  )  throw ( DWFException ) [virtual]
 

Sets an id for this presentation

Parameters:
zID A string that specifies the id
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentation::setLabel const DWFString zLabel  )  throw () [virtual]
 

Sets a user-friendly label for this presentation that

Parameters:
zLabel A string that specifies the label
Exceptions:
None 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:39 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5