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

StartDocument Class Reference

#include <dumbnode.h>

Inheritance diagram for StartDocument:

Node CCObject SimpleCCObject List of all members.

Public Member Functions

 StartDocument ()
 StartDocument (Node *ContextNode, AttachNodeDirection Direction, BOOL Locked=0, BOOL Mangled=0, BOOL Marked=0, BOOL Selected=0, BOOL Renderable=0)
 StartDocument 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: This object type has no purpose other than to sit at the beginning of the tree. It never has children, is not renderable and not selectable. It can never be deleted. There is only ever one and it is always the first object in the tree. It exists so that object can be inserted at the head of the tree without the pointer from the document to the tree having to be relinked - any object to be inserted at the head of the tree should be inserted after the StartOfDocument object.

Definition at line 122 of file dumbnode.h.

Constructor & Destructor Documentation

StartDocument::StartDocument (   )  [inline]
 

Definition at line 125 of file dumbnode.h.

00125 : Node() {};

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

StartDocument constructor.

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

Errors: -

See also:
-

Definition at line 129 of file dumbnode.cpp.

00135                                              :Node(ContextNode, Direction, Locked, Mangled,
00136                                                       Marked, Selected, Renderable)
00137 { 
00138 }

Member Function Documentation

UINT32 StartDocument::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 185 of file dumbnode.cpp.

00186 {     
00187     return (sizeof(StartDocument)); 
00188 }

BOOL StartDocument::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 202 of file dumbnode.cpp.

00203 {
00204     return TRUE;
00205 }

Node * StartDocument::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 161 of file dumbnode.cpp.

00162 {
00163     StartDocument* NodeCopy; 
00164     NodeCopy = new StartDocument();       
00165     ERRORIF(NodeCopy == NULL, _R(IDE_NOMORE_MEMORY), NULL); 
00166     CopyNodeContents(NodeCopy);   
00167     return (NodeCopy);
00168 }

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 04:01:25 2007 for Camelot by  doxygen 1.4.4