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

EndDocument Class Reference

#include <dumbnode.h>

Inheritance diagram for EndDocument:

Node CCObject SimpleCCObject List of all members.

Public Member Functions

 EndDocument ()
 EndDocument (Node *ContextNode, AttachNodeDirection Direction, BOOL Locked=0, BOOL Mangled=0, BOOL Marked=0, BOOL Selected=0, BOOL Renderable=0)
 EndDocument constructor.
virtual UINT32 GetNodeSize () const
 For finding the size of the node.
virtual BOOL IsPaper () const
 Indicate that we ARE paper! (Overrides virtual func in Node.).

Protected Member Functions

virtual 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.

Detailed Description

Created: 17/5/93 Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Purpose: An object which is always the last object in the tree. This ensures that we are always able to add objects at the end, just by inserting them before the EndOfDocument object

Definition at line 162 of file dumbnode.h.

Constructor & Destructor Documentation

EndDocument::EndDocument (   )  [inline]
 

Definition at line 166 of file dumbnode.h.

00166 : Node() {};

EndDocument::EndDocument (  Node *  ContextNode,
AttachNodeDirection  Direction,
BOOL  Locked = 0,
BOOL  Mangled = 0,
BOOL  Marked = 0,
BOOL  Selected = 0,
BOOL  Renderable = 0
) 
 

EndDocument constructor.

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

Errors: -

See also:
-

Definition at line 240 of file dumbnode.cpp.

00246                                   :Node(ContextNode, Direction, Locked, Mangled,
00247                                           Marked, Selected, Renderable)
00248 { 
00249 }

Member Function Documentation

UINT32 EndDocument::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 297 of file dumbnode.cpp.

00298 {     
00299     return (sizeof(EndDocument)); 
00300 }

BOOL EndDocument::IsPaper (   )  const [virtual]
 

Indicate that we ARE paper! (Overrides virtual func in Node.).

Author:
Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
Date:
25/11/94
Returns:
TRUE => we are a paper node.
See also:
Node::IsPaper

Reimplemented from Node.

Definition at line 314 of file dumbnode.cpp.

00315 {
00316     return TRUE;
00317 }

Node * EndDocument::SimpleCopy (  void   )  [protected, 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:
28/4/93
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 Node.

Definition at line 273 of file dumbnode.cpp.

00274 {
00275     EndDocument* NodeCopy; 
00276     NodeCopy = new EndDocument();       
00277     ERRORIF(NodeCopy == NULL, _R(IDE_NOMORE_MEMORY), NULL); 
00278     CopyNodeContents(NodeCopy);   
00279     return (NodeCopy);
00280 }

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