Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

AttrTxtTracking Class Reference

AttrTxtTracking specifies text tracking. More...

#include <txtattr.h>

Inheritance diagram for AttrTxtTracking:

AttrTxtBase NodeAttribute NodeRenderable Node CCObject SimpleCCObject List of all members.

Public Member Functions

 AttrTxtTracking ()
 Default constructor for AttrTxtTracking class.
 AttrTxtTracking (Node *ContextNode, AttachNodeDirection Direction, BOOL Locked=FALSE, BOOL Mangled=FALSE, BOOL Marked=FALSE, BOOL Selected=FALSE)
 Creates a AttrTxtTracking Attribute.
void Render (RenderRegion *pRender)
 'Renders' a Line Width attribute.
Node * SimpleCopy ()
 This method returns a shallow copy of the node with all Node pointers NULL. The function is virtual, and must be defined for all derived classes.
virtual INT32 operator== (const NodeAttribute &NodeAttrib)
 A virtual comparison operator. See NodeAttribute::operator== for a description of why it's required.
virtual UINT32 GetAttrNameID (void)
 Returns back a string resource ID describing the attribute.
virtual AttrIndex GetAttributeIndex ()
void GetDebugDetails (StringBase *Str)
 Used for debugging purposes during developement. Override in your own class and output suitable debugging details.
virtual UINT32 GetNodeSize () const
 For finding the size of the node.
virtual AttributeValue * GetAttributeValue ()
virtual void PolyCopyNodeContents (NodeRenderable *pNodeCopy)
 Polymorphically copies the contents of this node to another.
virtual BOOL WritePreChildrenWeb (BaseCamelotFilter *pFilter)
 Saves the text tracking attribute to the new file format filter.
virtual BOOL WritePreChildrenNative (BaseCamelotFilter *pFilter)

Public Attributes

TxtTrackingAttribute Value

Private Member Functions

void CopyNodeContents (AttrTxtTracking *NodeCopy)
 This method copies the node's contents to the node pointed to by NodeCopy.

Detailed Description

AttrTxtTracking specifies text tracking.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
07/03/95

Definition at line 1187 of file txtattr.h.

Constructor & Destructor Documentation

AttrTxtTracking::AttrTxtTracking (   ) 
 

Default constructor for AttrTxtTracking class.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/03/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 5888 of file txtattr.cpp.

05889 {
05890 }

AttrTxtTracking::AttrTxtTracking (  Node *  ContextNode,
AttachNodeDirection  Direction,
BOOL  Locked = FALSE,
BOOL  Mangled = FALSE,
BOOL  Marked = FALSE,
BOOL  Selected = FALSE
) 
 

Creates a AttrTxtTracking Attribute.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/03/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 5863 of file txtattr.cpp.

05869              : AttrTxtBase(ContextNode, Direction, Locked, Mangled, Marked, Selected)  
05870 {                         
05871 }

Member Function Documentation

void AttrTxtTracking::CopyNodeContents (  AttrTxtTracking *  NodeCopy  )  [private]
 

This method copies the node's contents to the node pointed to by NodeCopy.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
28/4/93
Parameters:
[INPUTS] 
A copy of this node [OUTPUTS]
Returns:
-

Errors: An assertion failure will occur if NodeCopy is NULL

Scope: protected

Definition at line 6010 of file txtattr.cpp.

06011 {
06012     // Let the base class do its bit
06013     NodeAttribute::CopyNodeContents( NodeCopy );
06014     
06015     //Copy contents specific to derived class here
06016     NodeCopy->Value.Tracking = Value.Tracking;
06017 }

virtual AttrIndex AttrTxtTracking::GetAttributeIndex (   )  [inline, virtual]
 

Reimplemented from NodeAttribute.

Definition at line 1209 of file txtattr.h.

01209 { return ATTR_TXTTRACKING; }

virtual AttributeValue* AttrTxtTracking::GetAttributeValue (   )  [inline, virtual]
 

Reimplemented from NodeAttribute.

Definition at line 1217 of file txtattr.h.

01217 { return &Value; }

UINT32 AttrTxtTracking::GetAttrNameID (  void   )  [virtual]
 

Returns back a string resource ID describing the attribute.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
22/2/94
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
Attribute description ID

Errors: -

See also:
-

Reimplemented from NodeAttribute.

Definition at line 5986 of file txtattr.cpp.

05987 {
05988     return (_R(IDS_TRACKING)); 
05989 }

void AttrTxtTracking::GetDebugDetails (  StringBase *  Str  )  [virtual]
 

Used for debugging purposes during developement. Override in your own class and output suitable debugging details.

Author:
Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
Date:
24/04/94
Parameters:
- [INPUTS]

Reimplemented from NodeRenderable.

Definition at line 6076 of file txtattr.cpp.

06077 {
06078     NodeAttribute::GetDebugDetails( Str );
06079 
06080     String_256 TempStr;
06081     TempStr._MakeMsg( TEXT("\r\nTracking=#1%ld\r\n"), Value.Tracking);
06082     (*Str) += TempStr;
06083 }

UINT32 AttrTxtTracking::GetNodeSize (   )  const [virtual]
 

For finding the size of the node.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
6/10/93
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
The size of the node in bytes
See also:
Node::GetSubtreeSize

Reimplemented from Node.

Definition at line 6058 of file txtattr.cpp.

06059 {     
06060     return (sizeof(AttrTxtTracking)); 
06061 }

INT32 AttrTxtTracking::operator== (  const NodeAttribute &  Attrib  )  [virtual]
 

A virtual comparison operator. See NodeAttribute::operator== for a description of why it's required.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/03/95
Parameters:
Atrib,: The attribute to compare, which must be an AttrLineWidth [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: An ENSURE failure will occur if Attrib does not have a AttrTxtTracking runtime class.

See also:
NodeAttribute::operator==

Reimplemented from NodeAttribute.

Definition at line 5961 of file txtattr.cpp.

05962 {
05963     ENSURE(Attrib.IsKindOf(CC_RUNTIME_CLASS(AttrTxtTracking)), 
05964         "Trying to compare two objects with different types"); 
05965     AttrTxtTracking* Attr = (AttrTxtTracking*) &Attrib;
05966     return (Attr->Value.Tracking == Value.Tracking); 
05967 }

void AttrTxtTracking::PolyCopyNodeContents (  NodeRenderable *  pNodeCopy  )  [virtual]
 

Polymorphically copies the contents of this node to another.

Author:
Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/12/2003
Parameters:
- [OUTPUTS]
Returns:
Errors: An assertion failure will occur if NodeCopy is NULL Scope: protected

Reimplemented from NodeRenderable.

Definition at line 6032 of file txtattr.cpp.

06033 {
06034     ENSURE(pNodeCopy, "Trying to copy a node's contents into a NULL node");
06035     ENSURE(IS_A(pNodeCopy, AttrTxtTracking), "PolyCopyNodeContents given wrong dest node type");
06036 
06037     if (IS_A(pNodeCopy, AttrTxtTracking))
06038         CopyNodeContents((AttrTxtTracking*)pNodeCopy);
06039 }

void AttrTxtTracking::Render (  RenderRegion *  pRegion  )  [virtual]
 

'Renders' a Line Width attribute.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/03/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Reimplemented from NodeAttribute.

Definition at line 5908 of file txtattr.cpp.

05909 {
05910     pRegion->SetTxtTracking(&Value, FALSE);
05911 }

Node * AttrTxtTracking::SimpleCopy (  void   )  [virtual]
 

This method returns a shallow copy of the node with all Node pointers NULL. The function is virtual, and must be defined for all derived classes.

Author:
Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
Date:
13/03/95
Parameters:
- [INPUTS]
[OUTPUTS] 
Returns:
A copy of the node, or NULL if memory runs out

Errors: If memory runs out when trying to copy, then ERROR is called with an out of memory error and the function returns NULL.

Scope: protected

Reimplemented from NodeAttribute.

Definition at line 5934 of file txtattr.cpp.

05935 {
05936     AttrTxtTracking* NodeCopy = new AttrTxtTracking();
05937     ERRORIF(NodeCopy == NULL, _R(IDE_NOMORE_MEMORY), NULL); 
05938     CopyNodeContents(NodeCopy);
05939     return NodeCopy;
05940 }

BOOL AttrTxtTracking::WritePreChildrenNative (  BaseCamelotFilter *  pFilter  )  [virtual]
 

Reimplemented from Node.

Definition at line 6109 of file txtattr.cpp.

06110 {
06111 #ifdef DO_EXPORT
06112     ERROR2IF(pFilter==NULL, FALSE, "Parameter pFilter == NULL.");
06113 
06114     return CXaraFileTxtTracking::WritePreChildrenNative(pFilter, this);
06115 #else
06116     return FALSE;
06117 #endif
06118 }

BOOL AttrTxtTracking::WritePreChildrenWeb (  BaseCamelotFilter *  pFilter  )  [virtual]
 

Saves the text tracking attribute to the new file format filter.

Author:
Andy_Hayward (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/07/96
Parameters:
pFilter - new camelot filter to save to [INPUTS]
Returns:
TRUE if successful, FALSE otherwise

Reimplemented from Node.

Definition at line 6098 of file txtattr.cpp.

06099 {
06100 #ifdef DO_EXPORT
06101     ERROR2IF(pFilter==NULL, FALSE, "Parameter pFilter == NULL.");
06102 
06103     return CXaraFileTxtTracking::WritePreChildrenWeb(pFilter, this);
06104 #else
06105     return FALSE;
06106 #endif
06107 }

Member Data Documentation

TxtTrackingAttribute AttrTxtTracking::Value
 

Definition at line 1230 of file txtattr.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:50:43 2007 for Camelot by  doxygen 1.4.4