DWFToolkit::DWFContentPresentationView Class Reference

Inheritance diagram for DWFToolkit::DWFContentPresentationView:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

The DWFContentPresentationView class supports alternate views of a presentation.

Since:
7.2
The DWFContentPresentationView class supports alternate views of a presentation.

Definition at line 61 of file ContentPresentationView.h.

Public Types

typedef DWFOrderedVector<
DWFContentPresentationView * > 
tList
 This type defines a list of DWFContentPresentationView pointers.
typedef DWFStringKeySkipList<
DWFContentPresentationView * > 
tMap
 This type defines a mapped collection of DWFContentPresentationView pointers.

Public Member Functions

_DWFTK_API DWFContentPresentationView (const DWFString &zLabel=L"", const DWFString &zID=L"") throw ()
virtual _DWFTK_API ~DWFContentPresentationView () 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 void setPropertySetID (const DWFString &zPropertySetID, bool bUseDefaultIfNotFound=true) throw ( DWFException )
virtual _DWFTK_API const DWFStringpropertySetID () const throw ()
virtual _DWFTK_API void setPropertySchemaID (const DWFString &zPropertySchemaID, bool bUseDefaultIfNotFound=false) throw ( DWFException )
virtual _DWFTK_API const DWFStringpropertySchemaID () const throw ()
virtual _DWFTK_API bool useDefaultPropertyIfNotFoundInSet () const throw ()
virtual _DWFTK_API void setHidden (bool bHidden) throw ()
virtual _DWFTK_API bool hidden () const throw ()
virtual _DWFTK_API DWFContentPresentationViewContainerparent () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
virtual _DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )

Friends

class DWFContentPresentationViewContainer


Constructor & Destructor Documentation

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

Constructor

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

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API bool DWFToolkit::DWFContentPresentationView::hidden  )  const throw () [inline, virtual]
 

Returns whether this view is hidden or not.

Returns:
Returns whether this view is hidden or not.
Exceptions:
None 

Definition at line 226 of file ContentPresentationView.h.

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

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

Returns:
The label for this view
Exceptions:
None 

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

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

Returns:
The label for this view
Exceptions:
None 

virtual _DWFTK_API DWFContentPresentationViewContainer* DWFToolkit::DWFContentPresentationView::parent  )  const throw () [inline, virtual]
 

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

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

Definition at line 239 of file ContentPresentationView.h.

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

Implements DWFCore::DWFXMLBuildable.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationView::propertySchemaID  )  const throw () [virtual]
 

Returns the schema id of the property set to be used to scope property references in this view.

Returns:
The schema id of the property set.
Exceptions:
None 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFContentPresentationView::propertySetID  )  const throw () [virtual]
 

Returns the property set id to be used to scope property references in this view.

Returns:
The property set id.
Exceptions:
None 

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

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationView::setHidden bool  bHidden  )  throw () [inline, virtual]
 

Specifies whether this view is hidden or not.

Parameters:
bHidden If true, this view will be marked as hidden.
Exceptions:
None 

Definition at line 213 of file ContentPresentationView.h.

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

Sets an id for this view.

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

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

Sets a user-friendly label for this view.

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

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationView::setPropertySchemaID const DWFString zPropertySchemaID,
bool  bUseDefaultIfNotFound = false
throw ( DWFException ) [virtual]
 

Sets a property schema id to be used to scope property references in this view

Parameters:
zPropertySchemaID The property schema id.
bUseDefaultIfNotFound If true and the property referred to in a property reference is missing, the content element will be queried for the property.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFContentPresentationView::setPropertySetID const DWFString zPropertySetID,
bool  bUseDefaultIfNotFound = true
throw ( DWFException ) [virtual]
 

Sets a property set id to be used to scope property references in this view.

Parameters:
zPropertySetID The property set id.
bUseDefaultIfNotFound If true and the property referred to in a property reference is missing, the content element will be queried for the property directly.
Exceptions:
None 

virtual _DWFTK_API bool DWFToolkit::DWFContentPresentationView::useDefaultPropertyIfNotFoundInSet  )  const throw () [inline, virtual]
 

Returns whether the default property must be used if it does not exist in the specified set.

Returns:
If true and the property referred to in a property reference is missing, the content element will be queried for the property.
Exceptions:
None 

Definition at line 200 of file ContentPresentationView.h.


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