DWFToolkit::DWFPublishedContentElement Class Reference
[DWF Publisher API]

#include "dwf/publisher/impl/PublishedContentElement.h"

List of all members.


Detailed Description

This is an implementation of the DWFPublishedObject, to capture relationships between a graphics element and some published structure, in this case the DWFPublishedDefinedObject.

Since:
7.2.0

Definition at line 56 of file PublishedContentElement.h.

Public Types

typedef DWFPublishedObject::tKey tKey
 Defines the data type used for published element keys.
typedef DWFSkipList< DWFPublishedObject::tKey,
DWFPublishedContentElement * > 
tMap
 This type defines a mapped collection of DWFPublishedObject pointers.

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFPublishedContentElement *) tList
 This type defines a list of DWFPublishedObject pointers.
_DWFTK_API DWFPublishedContentElement (tKey nKey, const DWFString &zName) throw ()
_DWFTK_API DWFPublishedContentElement (DWFPublishedContentElement &rSource) throw ()
_DWFTK_API DWFPublishedContentElementoperator= (DWFPublishedContentElement &rSource) throw ()
virtual _DWFTK_API ~DWFPublishedContentElement () throw ()
virtual _DWFTK_API void addReference (DWFPublishedObject *pObject, tKey nKey, const DWFString *pzInstanceName, bool bFromNamedSegment=false) throw ( DWFException )
_DWFTK_API bool hideFromDefaultModel () const throw ()
virtual _DWFTK_API bool setHideFromDefaultModel (DWFPublishedObject::tKey nKey) throw ()
virtual _DWFTK_API void setContentEntity (DWFEntity *pEntity, tKey nKey, const DWFString *pzInstanceName) throw ( DWFException )
virtual _DWFTK_API void setContentObject (DWFObject *pObject, tKey nKey) throw ( DWFException )
_DWFTK_API tReference * getNamedSegmentIncludeRef () const

Classes

class  _DWFTK_EXPORT_API_MEMORY_CONTROL_BASE
class  Factory
 This is an implementation of the DWFPublishedObject::Factory, to allow creation of the published content elements. More...
class  Visitor
 An implementation of the published object visitor to support content element generation. More...


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPublishedContentElement::DWFPublishedContentElement tKey  nKey,
const DWFString zName
throw ()
 

Constructor

Parameters:
nKey Unique identifier for the object.
zName Descriptive name for the object.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFPublishedContentElement::DWFPublishedContentElement DWFPublishedContentElement rSource  )  throw ()
 

Copy Constructor

Parameters:
rSource The object to copy.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFPublishedContentElement::addReference DWFPublishedObject pObject,
tKey  nKey,
const DWFString pzInstanceName,
bool  bFromNamedSegment = false
throw ( DWFException ) [virtual]
 

Creates a reference to an existing object. This should be defined in the derived classes.

Parameters:
pObject The object to reference.
nKey The unique identifier of the object from which the association is being made.
pzInstanceName An optional name for the reference relationship. Maybe NULL
bFromNamedSegment Is this addRereference call arising from a named segment.
Exceptions:
DWFException 

_DWFTK_API bool DWFToolkit::DWFPublishedContentElement::hideFromDefaultModel  )  const throw () [inline]
 

Determine whether the object is set to be hidden from the default model presentation.

Returns:
True if it is set to be hidden from the default model presentation.
Exceptions:
None 

Definition at line 523 of file PublishedContentElement.h.

_DWFTK_API DWFPublishedContentElement& DWFToolkit::DWFPublishedContentElement::operator= DWFPublishedContentElement rSource  )  throw ()
 

Assignment Operator

Parameters:
rSource The object to copy.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFPublishedContentElement::setContentEntity DWFEntity pEntity,
tKey  nKey,
const DWFString pzInstanceName
throw ( DWFException ) [virtual]
 

Set a content entity to associate with the segment. Instead of generating an entity for this segment's content object, the generated content object will be a realization of the provided entity.

Parameters:
pEntity The content entity to associate.
nKey The unique identifier of the object from which the association is being made.
pzInstanceName An optional name for the generated content object. Maybe NULL
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFPublishedContentElement::setContentObject DWFObject pObject,
tKey  nKey
throw ( DWFException ) [virtual]
 

Set an content object to associate with the segment. Instead of generating an object for the segment, it will use the provided object, and just create an instance for it. The name cannot be set since the object should already have a name.

Parameters:
pObject The content object to associate.
nKey The unique identifier of the object from which the association is being made.
Exceptions:
DWFException 

virtual _DWFTK_API bool DWFToolkit::DWFPublishedContentElement::setHideFromDefaultModel DWFPublishedObject::tKey  nKey  )  throw () [virtual]
 

Prevent the published object from publishing the object in the default model presentation. If the provided key is the same the key of this object, then this object is set to be hidden. If not, the references are searched to match the key value, and the flag is set on that reference.

Parameters:
nKey Key of the published object to hide from the model.
Returns:
False if the given key not found.
Exceptions:
None 
Since:
7.2.0


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