1 /************************************************************************/
2 /*									*/
3 /*  Pieces of text, physically implemented as a 'Section' thay are	*/
4 /*  outside the normal flow of text.					*/
5 /*									*/
6 /************************************************************************/
7 
8 #   ifndef	DOC_DOCUMENT_NOTE_H
9 #   define	DOC_DOCUMENT_NOTE_H
10 
11 #   include	"docDocumentTree.h"
12 #   include	<docEditPosition.h>
13 #   include	<docSelectionScope.h>
14 #   include	<docNoteProperties.h>
15 
16 /************************************************************************/
17 /*									*/
18 /*  Forward declarations of structs.					*/
19 /*									*/
20 /************************************************************************/
21 
22 struct BufferDocument;
23 struct BufferItem;
24 
25 /************************************************************************/
26 /*									*/
27 /*  A footnote/endnote/annotation.					*/
28 /*									*/
29 /*  1)  Though the notes are stored with the section, the paragraph	*/
30 /*	number is relative to the body of the document as a whole.	*/
31 /*									*/
32 /************************************************************************/
33 
34 typedef struct DocumentNote
35     {
36     DocumentTree	dnDocumentTree;
37     short int		dnNoteNumber;
38     short int		dnReferringPage;
39     short int		dnReferringColumn;
40     NoteProperties	dnNoteProperties;
41     } DocumentNote;
42 
43 # define NOTE_IS_DELETED( dn )	((dn)->dnNoteNumber < 0 )
44 
45 /************************************************************************/
46 /*									*/
47 /*  Routine declarations.						*/
48 /*									*/
49 /************************************************************************/
50 
51 extern void docInitNote(		DocumentNote *		dn );
52 
53 #   endif
54