home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / Java++ / SHAREDIDE / BIN / IDE / MFCAPWZ.DLL / TEMPLATE / README.TXT < prev    next >
Encoding:
Text File  |  1997-01-27  |  11.2 KB  |  297 lines
  1. ========================================================================
  2.        MICROSOFT FOUNDATION CLASS LIBRARY : $$Root$$
  3. ========================================================================
  4.  
  5.  
  6. $$IF(PROJTYPE_DLL)
  7. AppWizard has created this $$Root$$ DLL for you.  This DLL not only
  8. demonstrates the basics of using the Microsoft Foundation classes but
  9. is also a starting point for writing your DLL.
  10.  
  11. This file contains a summary of what you will find in each of the files that
  12. make up your $$Root$$ DLL.
  13. $$ELSE
  14. AppWizard has created this $$Root$$ application for you.  This application
  15. not only demonstrates the basics of using the Microsoft Foundation classes
  16. but is also a starting point for writing your application.
  17.  
  18. This file contains a summary of what you will find in each of the files that
  19. make up your $$Root$$ application.
  20. $$ENDIF //PROJTYPE_DLL
  21.  
  22. $$IF(PROJTYPE_DLL)
  23. $$IF(EXTDLL)
  24. $$Root$$.cpp
  25.     This is the main DLL source file that contains the definition of
  26.     DllMain().
  27. $$ELSE //!EXTDLL
  28. $$Root$$.h
  29.     This is the main header file for the DLL.  It declares the
  30.     $$APP_CLASS$$ class.
  31.  
  32. $$Root$$.cpp
  33.     This is the main DLL source file.  It contains the class $$APP_CLASS$$.
  34. $$IF(AUTOMATION)
  35.     It also contains the OLE entry points required of inproc servers.
  36. $$ENDIF //AUTOMATION
  37. $$ENDIF //EXTDLL
  38.  
  39. $$IF(AUTOMATION)
  40. $$Root$$.odl
  41.     This file contains the Object Description Language source code for the
  42.     type library of your DLL.
  43. $$ENDIF //AUTOMATION
  44. $$ELSE //!PROJTYPE_DLL
  45. $$Root$$.h
  46.     This is the main header file for the application.  It includes other
  47.     project specific headers (including Resource.h) and declares the
  48.     $$APP_CLASS$$ application class.
  49.  
  50. $$Root$$.cpp
  51.     This is the main application source file that contains the application
  52.     class $$APP_CLASS$$.
  53. $$ENDIF //PROJTYPE_DLL
  54.  
  55. $$Root$$.rc
  56.     This is a listing of all of the Microsoft Windows resources that the
  57.     program uses.  It includes the icons, bitmaps, and cursors that are stored
  58.     in the RES subdirectory.  This file can be directly edited in Microsoft
  59.     Developer Studio.
  60. $$IF(TARGET_MAC)
  61.  
  62. $$R_FILE$$.r
  63.     This file contains all of the Macintosh-specific resources for
  64. $$IF(PROJTYPE_DLL)
  65.     your DLL.
  66. $$ELSE //!PROJTYPE_DLL
  67.     your application.  For example, it contains the SIZE resource which you
  68.     can edit if you wish to change the memory partition size.  You can
  69.     also edit the FREF and BNDL resources when adding new document
  70.     types.
  71. $$ENDIF //PROJTYPE_DLL
  72. $$ENDIF //TARGET_MAC
  73. $$IF(!PROJTYPE_DLL)
  74.  
  75. res\$$Root$$.ico
  76.     This is an icon file, which is used as the application's icon.  This
  77.     icon is included by the main resource file $$Root$$.rc.
  78. $$ENDIF //!PROJTYPE_DLL
  79.  
  80. res\$$Root$$.rc2
  81.     This file contains resources that are not edited by Microsoft 
  82.     Developer Studio.  You should place all resources not
  83.     editable by the resource editor in this file.
  84. $$IF(!PROJTYPE_DLL)
  85. $$IF(CONTAINER_SERVER || FULL_SERVER || MINI_SERVER || AUTOMATION || HAS_SUFFIX)
  86.  
  87. $$Root$$.reg
  88.     This is an example .REG file that shows you the kind of registration
  89.     settings the framework will set for you.  You can use this as a .REG
  90. $$IF(PROJTYPE_DLG)
  91.     file to go along with your application.
  92. $$ELSE //!DLG
  93.     file to go along with your application or just delete it and rely
  94.     on the default RegisterShellFileTypes registration.
  95. $$ENDIF //PROJTYPE_DLG
  96. $$ENDIF //OLE || HAS_SUFFIX
  97. $$IF(TARGET_MAC)
  98. $$IF(CONTAINER_SERVER || FULL_SERVER || MINI_SERVER || AUTOMATION)
  99.  
  100. $$root$$Mac.reg
  101.     This is an example Macintosh registration file that shows you the kind
  102.     of settings the framework will set for you.  You'll notice this contains
  103.     mainly the same information as $$Root$$.reg, with some small exceptions
  104.     and with a slightly different format.  If you wish, you may copy it over
  105.     to your Macintosh with mfile:
  106.         mfile copy -l -t TEXT -c RgEd $$root$$Mac.reg ":<MacintoshPath>"
  107.     You may then double-click on the Macintosh file you just copied over, and
  108.     that will launch the Macintosh registration database editor and merge the
  109.     file into the database.  Remember, the framework will automatically enter
  110.     this information into the Macintosh registration database the first time
  111.     your application is run.  Still, your setup program should enter this
  112.     information into the database when your application is installed.
  113. $$ENDIF //SERVERS,AUTOMATION
  114. $$ENDIF //TARGET_MAC
  115. $$ENDIF //!PROJTYPE_DLL
  116. $$IF(AUTOMATION)
  117.  
  118. $$Root$$.odl
  119.     This file contains the Object Description Language source code for the
  120.     type library of your application.
  121. $$ENDIF //AUTOMATION
  122. $$IF(PROJTYPE_DLL)
  123.  
  124. $$Root$$.def
  125.     This file contains information about the DLL that must be
  126.     provided to run with Microsoft Windows.  It defines parameters
  127.     such as the name and description of the DLL.  It also exports
  128.     functions from the DLL.
  129. $$ENDIF //PROJTYPE_DLL
  130.  
  131. $$Root$$.clw
  132.     This file contains information used by ClassWizard to edit existing
  133.     classes or add new classes.  ClassWizard also uses this file to store
  134.     information needed to create and edit message maps and dialog data
  135.     maps and to create prototype member functions.
  136.  
  137. $$IF(!PROJTYPE_DLL)
  138. $$IF(!PROJTYPE_DLG)
  139. /////////////////////////////////////////////////////////////////////////////
  140.  
  141. For the main frame window:
  142.  
  143. $$FRAME_HFILE$$.h, $$FRAME_IFILE$$.cpp
  144.     These files contain the frame class $$FRAME_CLASS$$, which is derived from
  145. $$IF(PROJTYPE_MDI)
  146.     CMDIFrameWnd and controls all MDI frame features.
  147. $$ELSE
  148.     CFrameWnd and controls all SDI frame features.
  149. $$ENDIF
  150.  
  151. $$IF(TOOLBAR)
  152. res\Toolbar.bmp
  153.     This bitmap file is used to create tiled images for the toolbar.
  154.     The initial toolbar and status bar are constructed in the
  155.     $$FRAME_CLASS$$ class.  Edit this toolbar bitmap along with the
  156.     array in $$FRAME_IFILE$$.cpp to add more toolbar buttons.
  157. $$IF(MINI_SERVER || FULL_SERVER || CONTAINER_SERVER)
  158.  
  159. res\IToolbar.bmp
  160.     This bitmap file is used to create tiled images for the toolbar
  161.     when your server application is in-place activated inside another
  162.     container.  This toolbar is constructed in the $$IPFRAME_CLASS$$
  163.     class.  This bitmap is similar to the bitmap in res\Toolbar.bmp
  164.     except that it has many non-server commands removed.
  165. $$ENDIF
  166. $$ENDIF //TOOLBAR
  167.  
  168. /////////////////////////////////////////////////////////////////////////////
  169.  
  170. $$IF(!DB_NO_FILE)
  171. AppWizard creates one document type and one view:
  172.  
  173. $$DOC_HFILE$$.h, $$DOC_IFILE$$.cpp - the document
  174.     These files contain your $$DOC_CLASS$$ class.  Edit these files to
  175.     add your special document data and to implement file saving and loading
  176.     (via $$DOC_CLASS$$::Serialize).
  177. $$ELSE
  178. AppWizard creates one view:
  179. $$ENDIF
  180.  
  181. $$VIEW_HFILE$$.h, $$VIEW_IFILE$$.cpp - the view of the document
  182.     These files contain your $$VIEW_CLASS$$ class.
  183. $$IF(!DB_NO_FILE)
  184.     $$VIEW_CLASS$$ objects are used to view $$DOC_CLASS$$ objects.
  185. $$ENDIF
  186. $$IF(CRecordView)
  187. $$RECSET_HFILE$$.h, $$RECSET_IFILE$$.cpp - the recordset
  188.     These files contain your $$RECSET_CLASS$$ class.
  189. $$ENDIF
  190.  
  191. $$IF(PROJTYPE_MDI)
  192. res\$$DOC_IFILE$$.ico
  193.     This is an icon file, which is used as the icon for MDI child windows
  194.     for the $$DOC_CLASS$$ class.  This icon is included by the main
  195.     resource file $$Root$$.rc.
  196. $$ENDIF //MDI
  197.  
  198. $$IF(CONTAINER || FULL_SERVER || MINI_SERVER || CONTAINER_SERVER)
  199. /////////////////////////////////////////////////////////////////////////////
  200.  
  201. AppWizard has also created classes specific to OLE
  202.  
  203. $$IF(CONTAINER || CONTAINER_SERVER)
  204. $$CNTRITEM_HFILE$$.h, $$CNTRITEM_IFILE$$.cpp - this class is used to
  205.     manipulate OLE objects.  They are usually displayed by your
  206.     $$VIEW_CLASS$$ class and serialized as part of your $$DOC_CLASS$$ class.
  207.  
  208. $$ENDIF
  209. $$IF(MINI_SERVER || FULL_SERVER || CONTAINER_SERVER)
  210. $$SRVRITEM_HFILE$$.h, $$SRVRITEM_IFILE$$.cpp - this class is used to
  211.     connect your $$DOC_CLASS$$ class to the OLE system, and optionally
  212.     provide links to your document.
  213. $$IPFRAME_HFILE$$.h, $$IPFRAME_IFILE$$.cpp - this class is derived
  214.     from COleIPFrameWnd and controls all frame features during
  215.     in-place activation.
  216. $$ENDIF
  217. $$ENDIF
  218. $$ELSE //!!PROJTYPE_DLG
  219.  
  220. /////////////////////////////////////////////////////////////////////////////
  221.  
  222. $$IF(AUTOMATION)
  223. AppWizard creates one dialog class and automation proxy class:
  224. $$ELSE //!AUTOMATION
  225. AppWizard creates one dialog class:
  226. $$ENDIF //AUTOMATION
  227.  
  228. $$DLG_HFILE$$.h, $$DLG_IFILE$$.cpp - the dialog
  229.     These files contain your $$DLG_CLASS$$ class.  This class defines
  230.     the behavior of your application's main dialog.  The dialog's
  231.     template is in $$Root$$.rc, which can be edited in Microsoft
  232.     Developer Studio.
  233. $$IF(AUTOMATION)
  234.  
  235. $$DLGAUTOPROXY_HFILE$$.h, $$DLGAUTOPROXY_IFILE$$.cpp - the automation object
  236.     These files contain your $$DLGAUTOPROXY_CLASS$$ class.  This class
  237.     is called the "automation proxy" class for your dialog, because it
  238.     takes care of exposing the automation methods and properties that
  239.     automation controllers can use to access your dialog.  These methods
  240.     and properties are not exposed from the dialog class directly, because
  241.     in the case of a modal dialog-based MFC application it is cleaner and
  242.     easier to keep the OLE automation object separate from the user interface.
  243. $$ENDIF //AUTOMATION
  244.  
  245. $$ENDIF //!PROJTYPE_DLG
  246. $$IF(HELP)
  247. /////////////////////////////////////////////////////////////////////////////
  248.  
  249. Help Support:
  250.  
  251. MakeHelp.bat
  252.     Use this batch file to create your application's Help file, hlp\$$Root$$.hLP.
  253.  
  254. hlp\$$Root$$.hpj
  255.     This file is the Help Project file used by the Help compiler to create
  256.     your application's Help file.
  257.  
  258. hlp\*.bmp
  259.     These are bitmap files required by the standard Help file topics for
  260.     Microsoft Foundation Class Library standard commands.
  261.  
  262. hlp\*.rtf
  263.     This file contains the standard help topics for standard MFC
  264.     commands and screen objects.
  265. $$ENDIF //HELP
  266.  
  267. $$ENDIF //!PROJTYPE_DLL
  268. /////////////////////////////////////////////////////////////////////////////
  269. Other standard files:
  270.  
  271. StdAfx.h, StdAfx.cpp
  272.     These files are used to build a precompiled header (PCH) file
  273.     named $$Root$$.pch and a precompiled types file named StdAfx.obj.
  274.  
  275. Resource.h
  276.     This is the standard header file, which defines new resource IDs.
  277.     Microsoft Developer Studio reads and updates this file.
  278.  
  279. /////////////////////////////////////////////////////////////////////////////
  280. Other notes:
  281.  
  282. AppWizard uses "TODO:" to indicate parts of the source code you
  283. should add to or customize.
  284. $$IF(PROJTYPE_MDI || PROJTYPE_SDI || PROJTYPE_DLG)
  285.  
  286. If your application uses MFC in a shared DLL, and your application is 
  287. in a language other than the operating system's current language, you
  288. will need to copy the corresponding localized resources MFC40XXX.DLL
  289. from the Microsoft Visual C++ CD-ROM onto the system or system32 directory,
  290. and rename it to be MFCLOC.DLL.  ("XXX" stands for the language abbreviation.
  291. For example, MFC40DEU.DLL contains resources translated to German.)  If you
  292. don't do this, some of the UI elements of your application will remain in the
  293. language of the operating system.
  294. $$ENDIF //MDI,SDI,DLG
  295.  
  296. /////////////////////////////////////////////////////////////////////////////
  297.