home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Developer / objc / appkit / Starter.1.1.README < prev    next >
Encoding:
Text File  |  1995-03-07  |  5.4 KB  |  147 lines
  1. This is README for the Starter App, written by 
  2. Robert Vasvari Dec 1994.
  3.  
  4.  
  5.     The Starter Application
  6.  
  7.  
  8.  
  9.     What is Starter ?
  10.  
  11.     Starter is an app that does nothing and looks great doing it... :)
  12.  
  13.     When a developer set out to build a new app, there are many
  14.     functionalities and mechanisms that need to be implemented.
  15.     The purpose of the Starter app is to provide the developer
  16.     with a framework that has all these mechanisms already working
  17.     in some basic way, so that instead of implementing them from
  18.     scratch, they can simply be extended in a kind of "fill in the 
  19.     blanks" way.
  20.     
  21.     Starter is great for developers who are not yet familiar with
  22.     all the basic Mechanisms in NEXTSTEP and would still like to
  23.     write an app that conforms to the general guide lines of NS.
  24.     The code is not complicated, and browsing through it is a 
  25.     great way to learn NEXTSTEP programming.
  26.  
  27.  
  28.     List of these general features:
  29.  
  30. 1:     Create, destroy, open, revert and save document files
  31.     All documents are in their seperate zones.
  32.     When a document is closed, its zone is destroyed.
  33.     All three save functions (Save, Save As, Save To) are
  34.     provided. Saving documents is done by opening a stream,
  35.     putting clear text into it, then saving it to a file.
  36.  
  37. 2:    Multiple screen Inspector panel that changes with the
  38.     currently selected document. 
  39.     This Inspector is modeled
  40.     after the Workspace Inspector. The top part contains
  41.     a textfield for the filename that will change its font
  42.     to make sure the entire name fits (within reasonable
  43.     limits, of course). The default implementation contains
  44.     two screens. More screens can very easily be added. The 
  45.     screens can be invoked by by typing <COMMAND><Screen#>
  46.     just like the Workspace. 
  47.  
  48. 3:    Multiple screen Preferences window. 
  49.     Each screen contains
  50.     items that are saved as defaults for the program.
  51.     The Set and Revert buttons become enabled/disabled according
  52.     to changes made (even on the textfields).
  53.     Pressing the Set button saves the changes into the Defaults
  54.     Database. There are utility routines provided to get defaults
  55.     of different types with error checking (util.h/m).
  56.  
  57. 4:    Menus that enable/disable themselves according to current
  58.     selection. 
  59.     This done through the [NXApp updateWindows] method
  60.     which gets called after any change in the program. The method
  61.     in turn calls each window in the app (including the menus) to
  62.     update themselves.
  63.     
  64. 5:      A Controller object that is the delegate of NXApp, it performs
  65.     all interfacing between the menus, the worspace and the documents.
  66.     Also keeps a list of documents. A document can either be opened
  67.     or just put to the fron if it is already open. Upon termination
  68.     a standard process is performed to save altered documents.
  69.     
  70. 6:      A RemoteManager object is a simple Distributed Objects interface.
  71.     It makes Starter a server, such that other apps can remotely message
  72.     it to open, hide docs, etc... These simple operations demonstrate
  73.     the ease of use for the DO interface.
  74.     
  75.  
  76.         List of classes: 
  77.  
  78. AdjFontTextField:     changes fontsize according to contents.
  79. ClockView:         Displays date graphically in the inspector.
  80. CommandView:     routes <COMMAND><Screen#> keystrokes to the inspector.
  81. Controller:        Application's delegate.
  82. DocumentWindow:    sends updateWindows message on Miniaturize.
  83. Document:         Generic document that Save/Load itself.
  84. InspectorManager:     subclass of MultipleScreenManager that dynamically
  85.             changes its contents according to the current selection.
  86. KeyPanel:        subclass of panel with a button that shows a return sign
  87.             only if the panel is the Key Window af the app.
  88. MenuController:     subclass of controller that updates all menucells.
  89. MultipleScreenManager: Changes the screens by the popup button on 
  90.             the top of the panel.
  91. PreferenceManager:     subclass of MultipleScreenManager, saves 
  92.             changes per screeen.
  93. RemoteServer:         provides methods that can be called from other apps through
  94.             the Distributed Objects interface.
  95.  
  96. util.m/h:         utility routines.
  97.  
  98.  
  99.     How do I use Starter ?
  100.  
  101.     There are a few simple steps to perform to change the name to the new name
  102.     of your application:
  103.     1: Change the name of the project directory to AppName;
  104.     2: Change the name of English.lproj/Starter.nib to English.lproj/AppName.nib;
  105.     3: in defs.h change the value for DOC_EXTENSION to the new document ext.;
  106.     4: Start Project Builder by double-clicking on PB.project;
  107.        a: In the Attributes Window, change project name and doc extension;
  108.        b: In the Files/Interfaces Window remove Starter.nib and add AppName.nib;
  109.        c: Save PB.project
  110.     5: build app;
  111.     6: At this point you are ready to implement your own features..
  112.  
  113.  
  114. Release Notes on current version:
  115.  
  116.     This version is using the foundation kit as much as possible.
  117.     The document object is a subclass of NSObject (and that is what
  118.     counts). There are also some utility additions to NSObject and
  119.     window that are kinda handy. The current release contains more classes
  120.     than the previous one. The idea is, that the classes whose name starts
  121.     with ST should be subclassed, and the real work should be done
  122.     by the subclasses only. This permits the easy implementation of
  123.     "high level" changes. 
  124.     
  125.     
  126. Correspondence:
  127.  
  128.     Please send me ideas on what other general functionalities
  129.     to implement in Starter!
  130.     
  131.     Comments, bugreports, suggestions should all go to:
  132.     
  133.     vrobi@futon.sfsu.edu
  134.     
  135.     
  136.     Enjoy!!!
  137.     
  138.                 =[vrobi]=
  139.  
  140. Legal Stuff:
  141.  
  142.     I make no promises to the fitness of this stuff for any purpose,
  143.     blah, blah, lawyer crap, etc....
  144.     Whatever you do with it, do not stuff it down your throat.
  145.  
  146.