home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 February: Tool Chest / Dev.CD Feb 94.toast / Tool Chest / OS⁄Toolbox / Apple Events / AE & Scripting Dev Kit / AE Sample Applications / Quill 1.0d1 / Quill Code / Quill.h < prev    next >
Encoding:
Text File  |  1992-03-05  |  10.8 KB  |  281 lines  |  [TEXT/MPS ]
  1. /*------------------------------------------------------------------------------
  2. #
  3. #    Quill
  4. #
  5. #    Apple Macintosh User Programming Group
  6. #
  7. #    MultiFinder-Aware, AppleEvents-Aware Simple Styled TextEdit Sample Application
  8. #
  9. #    by Bennet Marks
  10. #
  11. #    Copyright © 1991 Apple Computer, Inc.
  12. #
  13. #    Quill based on TEStyleSample  (Copyright © 1989 Apple Computer, Inc.)
  14. #
  15. #
  16. #    Quill.h    -    Rez Source
  17. #
  18. #    All rights reserved.
  19. #
  20. #    Versions:    1.0                        02/18/91
  21. #
  22. #    Components:    Quill.p
  23. #                QuillGlue.a
  24. #                Quill.r
  25. #                Quill.h    
  26. #                Quill.make
  27. #
  28. #    Quill is an example application that demonstrates how 
  29. #    to initialize the commonly used toolbox managers, operate 
  30. #    successfully under MultiFinder, handle desk accessories and 
  31. #    create, grow, and zoom windows. Both styled and fundamental TextEdit 
  32. #    toolbox calls and TextEdit autoscroll are demonstrated. It 
  33. #    also shows how to create and maintain scrollbar controls as well
  34. #    as implementing a basic printing loop.
  35. #
  36. #   It also handles AppleEvents, and is written with an eye towards
  37. #   making it work with the AppleEvents Object Model and the Open Scripting
  38. #   Architecture. It was built on TEStyleSample, with more functionality and
  39. #   AppleEvent awareness added in.
  40. #
  41. #    It does not by any means demonstrate all the techniques you 
  42. #    need for a large application. In particular, Quill does not 
  43. #    cover exception handling, multiple windows/documents, 
  44. #    sophisticated memory management, or undo. All of 
  45. #    these are vital parts of a normal full-sized application.
  46. #
  47. #    This application is an example of the form of a Macintosh 
  48. #    application; it is NOT a template. It is NOT intended to be 
  49. #    used as a foundation for the next world-class, best-selling, 
  50. #    600K application. A stick figure drawing of the human body may 
  51. #    be a good example of the form for a painting, but that does not 
  52. #    mean it should be used as the basis for the next Mona Lisa.
  53. #
  54. #    We recommend that you review this program, TESample or Sample before 
  55. #    beginning a new application. TESample is a simpler version of Quill
  56. #    without styles and Sample is a simple app. which doesn’t 
  57. #    use TextEdit or the Control Manager.
  58. #
  59. ------------------------------------------------------------------------------*/
  60.  
  61. /*    These #defines correspond to values in the Pascal source code.
  62.     Quill.c and Quill.r include this file. */
  63.  
  64. /*    Determining an application's minimum size to request from MultiFinder depends
  65.     on many things, each of which can be unique to an application's function,
  66.     the anticipated environment, the developer's attitude of what constitutes
  67.     reasonable functionality and performance, etc. Here is a list of some things to
  68.     consider when determining the minimum size (and preferred size) for your
  69.     application. The list is pretty much in order of importance, but by no means
  70.     complete.
  71.     
  72.     1.    What is the minimum size needed to give almost 100 percent assurance
  73.         that the application won't crash because it ran out of memory? This
  74.         includes not only things that you do have direct control over such as
  75.         checking for NIL handles and pointers, but also things that some
  76.         feel are not so much under their control such as QuickDraw and the
  77.         Segment Loader.
  78.         
  79.     2.    What kind of performance can a user expect from the application when
  80.         it is running in the minimum memory configuration? Performance includes
  81.         not only speed in handling data, but also things like how many documents
  82.         can be opened, etc.
  83.         
  84.     3.    What are the typical sizes of scraps is [a boy dog] that a user might
  85.         wish to work with when lauching or switching to your application? If
  86.         the amount of memory is too small, the scrap may get lost [will have
  87.         to be shot]. This can be quite frustrating to the user.
  88.         
  89.     4.    The previous items have concentrated on topics that tend to cause an
  90.         increase in the minimum size to request from MultiFinder. On the flip
  91.         side, however, should be the consideration of what environments the
  92.         application may be running in. There may be a high probability that
  93.         many users with relatively small memory configurations will want to
  94.         avail themselves of your application. Or, many users might want to use it
  95.         while several other, possibly related/complementary applications are
  96.         running. If that is the case, it would be helpful to have a fairly
  97.         small minimum size.
  98.     
  99.     What we did for Quill:
  100.     
  101.         We determined the smallest heap size that Quill could have and still
  102.         run (22K). For the preferred size we added enough space to permit:
  103.             a. a maximum size TextEdit text handle (32000 characters)
  104.             b. a maximum usable TextEdit scrap (32000 characters)
  105.             b. a maximum scrap as a result of Copy (32000 characters)
  106.             d. a little performance cushion (see 2, above) (10K)
  107.         Result: 122K for preferred size
  108.         
  109.         For the minimum size we took the 22K and then scaled down our requirements
  110.         for a,b, and c above. We thought that providing 16K more would be lean
  111.         and mean (see 4, above).
  112.         Result: 38K for minimum size
  113. */
  114.  
  115. #define kPrefSize                122
  116. #define kMinSize                38
  117.     
  118. /* The following constants are used to identify menus and their items. The menu IDs
  119.    have an "m" prefix and the item numbers within each menu have an "i" prefix. */
  120. #define    mApple                    128        /* Apple menu */
  121. #define    iAbout                    1
  122.  
  123. #define    mFile                    129        /* File menu */
  124. #define    iNew                    1
  125. #define    iClose                    4
  126. #define    iQuit                    12
  127.  
  128. #define    mEdit                    130        /* Edit menu */
  129. #define    iUndo                    1
  130. #define    iCut                    3
  131. #define    iCopy                    4
  132. #define    iPaste                    5
  133. #define    iClear                    6
  134. #define iSelectAll                8
  135.  
  136. #define mFont                    131        /* Font menu         */
  137.  
  138. #define mFontSize                132        /* Font Size menu     */
  139.  
  140. #define mStyle                    133        /* Style menu         */
  141. #define iPlain                    1
  142. #define iBold                    3
  143. #define iItalic                    4
  144. #define iUnderline                5
  145. #define iOutline                6
  146. #define iShadow                    7
  147.  
  148. #define mMathoms                134
  149. #define iShowAllErrs            1
  150. #define iRunScript                2
  151.  
  152. /* kTopLeft - This is for positioning the Disk Initialization dialogs. */
  153.  
  154. #define kDITop                    0x0050
  155. #define kDILeft                    0x0070
  156.  
  157. /*    kTextMargin is the number of pixels we leave blank at the edge of the window. */
  158. #define kTextMargin                2
  159.  
  160. /* kMaxOpenDocuments is used to determine whether a new document can be opened
  161.    or created. We keep track of the number of open documents, and disable the
  162.    menu items that create a new document when the maximum is reached. If the
  163.    number of documents falls below the maximum, the items are enabled again. */
  164. #define    kMaxOpenDocuments        1
  165.     
  166. /*    kMaxDocWidth is an arbitrary number used to specify the width of the TERec's
  167.     destination rectangle so that word wrap and horizontal scrolling can be
  168.     demonstrated. */
  169. #define    kMaxDocWidth            576
  170.     
  171. /* kMinDocDim is used to limit the minimum dimension of a window when GrowWindow
  172.     is called. */
  173. #define    kMinDocDim                64
  174.  
  175. /*    kControlInvisible is used to 'turn off' controls (i.e., cause the control not
  176.     to be redrawn as a result of some Control Manager call such as SetCtlValue)
  177.     by being put into the contrlVis field of the record. kControlVisible is used
  178.     the same way to 'turn on' the control. */
  179. #define kControlInvisible        0
  180. #define kControlVisible            0xFF
  181.  
  182. /*    kScrollbarAdjust and kScrollbarWidth are used in calculating
  183.     values for control positioning and sizing. */
  184. #define kScrollbarWidth            16
  185. #define kScrollbarAdjust        (kScrollbarWidth - 1)
  186.  
  187. /*    kScrollTweek compensates for off-by-one requirements of the scrollbars
  188.  to have borders coincide with the growbox. */
  189. #define kScrollTweek            2
  190.     
  191. /*    kCrChar is used to match with a carriage return when calculating the
  192.     number of lines in the TextEdit record. kDelChar is used to check for
  193.     delete in keyDowns. */
  194. #define kCrChar                    13
  195. #define kDelChar                8
  196.     
  197. /*    kButtonScroll is how many pixels to scroll horizontally when the button part
  198.     of the horizontal scrollbar is pressed. */
  199. #define kButtonScroll            4
  200.     
  201. /*    kMaxTELength is an arbitrary number used to limit the length of text in the TERec
  202.     so that various errors won't occur from too many characters in the text. */
  203. #define    kMaxTELength            32000
  204.  
  205. /* kSysEnvironsVersion is passed to SysEnvirons to tell it which version of the
  206.    SysEnvRec we understand. */
  207. #define    kSysEnvironsVersion        1
  208.  
  209. /* kOSEvent is the event number of the suspend/resume and mouse-moved events sent
  210.    by MultiFinder. Once we determine that an event is an OSEvent, we look at the
  211.    high byte of the message sent to determine which kind it is. To differentiate
  212.    suspend and resume events we check the resumeMask bit. */
  213. #define    kOSEvent                app4Evt    /* event used by MultiFinder */
  214. #define    kSuspendResumeMessage    1        /* high byte of suspend/resume event message */
  215. #define    kResumeMask                1        /* bit of message field for resume vs. suspend */
  216. #define    kMouseMovedMessage        0xFA    /* high byte of mouse-moved event message */
  217.  
  218. /* kMinHeap - This is the minimum result from the following
  219.      equation:
  220.             
  221.             ORD(GetApplLimit) - ORD(ApplicZone)
  222.             
  223.      for the application to run. It will insure that enough memory will
  224.      be around for reasonable-sized scraps, FKEYs, etc. to exist with the
  225.      application, and still give the application some 'breathing room'.
  226.      To derive this number, we ran under a MultiFinder partition that was
  227.      our requested minimum size, as given in the 'SIZE' resource. */
  228.      
  229. #define    kMinHeap                 (29 * 1024)
  230.     
  231. /* kMinSpace - This is the minimum result from PurgeSpace, when called
  232.      at initialization time, for the application to run. This number acts
  233.      as a double-check to insure that there really is enough memory for the
  234.      application to run, including what has been taken up already by
  235.      pre-loaded resources, the scrap, code, and other sundry memory blocks. */
  236.      
  237. #define    kMinSpace                (20 * 1024)
  238.  
  239. /*    kExtremeNeg and kExtremePos are used to set up wide open rectangles and regions. */
  240. #define kExtremeNeg                -32768
  241. #define kExtremePos                (32767 - 1) /* required to address an old region bug */
  242.     
  243. /* kTESlop provides some extra security when pre-flighting edit commands. */
  244. #define    kTESlop                    1024
  245.  
  246. /* The following are indicies into STR# resources. */
  247. #define    eWrongMachine            1
  248. #define    eSmallSize                2
  249. #define    eNoMemory                3
  250. #define    eNoSpaceCut                4
  251. #define    eNoCut                    5
  252. #define    eNoCopy                    6
  253. #define    eExceedPaste            7
  254. #define    eNoSpacePaste            8
  255. #define    eNoWindow                9
  256. #define    eExceedChar                10
  257. #define    eNoPaste                11
  258. #define    eNoNull                    12
  259. #define    eNoSelfAddr                13
  260.  
  261. #define    rMenuBar    128                /* application's menu bar */
  262. #define    rAboutAlert    128                /* about alert */
  263. #define    rUserError    129                /* user error alert */
  264. #define    rUserAlert    130                /* user alert */
  265. #define rYesOrNo    131                /* yes/no/cancel screen */
  266. #define    rDocWindow    128                /* application's window */
  267. #define    rVScroll    128                /* vertical scrollbar control */
  268. #define    rHScroll    129                /* horizontal scrollbar control */
  269. #define    kErrStrings    128                /* error string list */
  270.  
  271.  
  272.  
  273. /* defines for the disable/enable flags */
  274. /* use these for easier reading            */
  275.  
  276. #define AllItems    0b1111111111111111111111111111111
  277. #define NoItems        0b0000000000000000000000000000000    
  278. #define MenuItem2    0b0000000000000000000000000000010    
  279. #define MenuItem12    0b0000000000000000000100000000000    
  280.  
  281.