home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 …ember: Reference Library / Apple Developer Reference Library (December 1999) (Disk 1).iso / pc / technical documentation / develop / develop issue 28 / develop issue 28 code / sketch / source / adts / documentadt.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-08-03  |  2.7 KB  |  58 lines
  1. /****************************************************************************
  2.  * 
  3.  * DocumentADT.h
  4.  * 
  5.  * Public functions, structures and constants for the Document Abstract Data Type
  6.  * 
  7.  ****************************************************************************/
  8.  
  9. #ifndef __DOCUMENTADT__
  10. #define __DOCUMENTADT__
  11.  
  12. #include "Structs.h"
  13.  
  14. DocumentList            GetDocumentList                                        (void);
  15. OSErr                        DocumentError                                            (void);
  16. void                        CreateDocumentList                                    (void);
  17. DocumentReference        CreateDocument                                            (DocumentList list, DocumentType documentType);
  18. short                        CountDocuments                                            (DocumentList list);
  19. void                        DestroyDocumentList                                    (DocumentList list);
  20. void                        DestroyDocument                                        (DocumentReference document);
  21. DocumentReference        GetFirstDocument                                        (DocumentList list);
  22. DocumentReference        GetLastDocument                                        (DocumentList list);
  23.  
  24. //
  25. // --- Acessors
  26. //
  27.  
  28. short                        GetDocumentNumber                                        (DocumentReference document);
  29. DocumentType            GetDocumentType                                        (DocumentReference document);
  30. void                        GetDocumentName                                        (DocumentReference document, StringPtr documentName);
  31. DocumentReference        GetDocumentNextDocument                                (DocumentReference document);
  32. DocumentReference        GetDocumentPreviousDocument                        (DocumentReference document);
  33. unsigned short            GetDocumentNumberOfChanges                            (DocumentReference document);
  34. WindowPtr               GetDocumentWindow                                        (DocumentReference document);
  35. ElementList             GetDocumentElementList                                (DocumentReference document);
  36. unsigned long            GetDocumentChangeLevel                                (DocumentReference document);
  37. Rect                        GetDocumentCanvasRect                                (DocumentReference document);
  38. short                        GetDocumentMaxWidth                                    (DocumentReference document);
  39. short                        GetDocumentMaxHeight                                    (DocumentReference document);
  40.  
  41.  
  42. //
  43. // --- Manipulators
  44. //
  45.  
  46. void                        SetDocumentType                                        (DocumentReference document, DocumentType documentType);
  47. void                        SetDocumentName                                        (DocumentReference document, ConstStr63Param documentName);
  48. void                        SetDocumentNextDocument                                (DocumentReference document, DocumentReference next);
  49. void                        SetDocumentPreviousDocument                        (DocumentReference document, DocumentReference previous);
  50. void                        SetDocumentNumberOfChanges                            (DocumentReference document, unsigned short numberOfChanges);
  51. void                        SetDocumentWindow                                        (DocumentReference document, WindowPtr window);
  52. void                        SetDocumentElementList                                (DocumentReference document, ElementList list);
  53. void                        SetDocumentChangeLevel                                (DocumentReference document, unsigned long level);
  54. void                        SetDocumentMaxWidth                                    (DocumentReference document, short maxWidth);
  55. void                        SetDocumentMaxHeight                                    (DocumentReference document, short maxHeight);
  56.  
  57. #endif
  58.