home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / appwiz / logowiz / template / readme.txt < prev    next >
Text File  |  1998-03-05  |  13KB  |  337 lines
  1. ========================================================================
  2.        MICROSOFT FOUNDATION CLASS LIBRARY : $$Root$$
  3. ========================================================================
  4.  
  5.  
  6. $$IF(PROJTYPE_DLL)
  7. Custom AppWizard "My Logo AppWizard" has created this $$ROOT$$ DLL for
  8. you.  This DLL not only demonstrates the basics of using the Microsoft
  9. Foundation classes but 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. Custom AppWizard "My Logo AppWizard" has created this $$ROOT$$ application
  15. for you.  This application not only demonstrates the basics of using the
  16. Microsoft Foundation classes but is also a starting point for writing your
  17. application.
  18.  
  19. $$IF(LOGO_YES || PRESS_ME_DIALOG)
  20. Custom AppWizard "My Logo AppWizard" added the following extra functionality
  21. for you:
  22.  
  23. $$IF(LOGO_YES)
  24. $$IF(LOGO_UPLEFT)
  25.     - the IDR_MAINFRAME icon was placed in the upper left corner of your
  26. $$ELIF(LOGO_LOLEFT)
  27.     - the IDR_MAINFRAME icon was placed in the lower left corner of your
  28. $$ELSE  //(LOGO_LORIGHT)
  29.     - the IDR_MAINFRAME icon was placed in the lower right corner of your
  30. $$ENDIF
  31.       dialog-based app
  32. $$ENDIF //LOGO_YES
  33. $$IF(PRESS_ME_DIALOG)
  34.     - a button labeled 'Press me' was placed near the center of your dialog-
  35.       based app.  Pressing this button will bring up a dialog that contains
  36.       two owner-draw bitmap buttons
  37. $$ENDIF
  38.  
  39. $$ENDIF //LOGO_YES || PRESS_ME_DIALOG
  40. This file contains a summary of what you will find in each of the files that
  41. make up your $$Root$$ application.
  42. $$ENDIF //PROJTYPE_DLL
  43.  
  44. $$Root$$.dsp
  45.     This file (the project file) contains information at the project level and
  46.     is used to build a single project or subproject. Other users can share the
  47.     project (.dsp) file, but they should export the makefiles locally.
  48.  
  49. $$IF(PROJTYPE_DLL)
  50. $$IF(EXTDLL)
  51. $$Root$$.cpp
  52.     This is the main DLL source file that contains the definition of
  53.     DllMain().
  54. $$ELSE //!EXTDLL
  55. $$Root$$.h
  56.     This is the main header file for the DLL.  It declares the
  57.     $$APP_CLASS$$ class.
  58.  
  59. $$Root$$.cpp
  60.     This is the main DLL source file.  It contains the class $$APP_CLASS$$.
  61. $$IF(AUTOMATION)
  62.     It also contains the OLE entry points required of inproc servers.
  63. $$ENDIF //AUTOMATION
  64. $$ENDIF //EXTDLL
  65.  
  66. $$IF(AUTOMATION)
  67. $$Root$$.odl
  68.     This file contains the Object Description Language source code for the
  69.     type library of your DLL.
  70. $$ENDIF //AUTOMATION
  71. $$ELSE //!PROJTYPE_DLL
  72. $$Root$$.h
  73.     This is the main header file for the application.  It includes other
  74.     project specific headers (including Resource.h) and declares the
  75.     $$APP_CLASS$$ application class.
  76.  
  77. $$Root$$.cpp
  78.     This is the main application source file that contains the application
  79.     class $$APP_CLASS$$.
  80. $$ENDIF //PROJTYPE_DLL
  81.  
  82. $$Root$$.rc
  83.     This is a listing of all of the Microsoft Windows resources that the
  84.     program uses.  It includes the icons, bitmaps, and cursors that are stored
  85.     in the RES subdirectory.  This file can be directly edited in Microsoft
  86.     Visual C++.
  87.  
  88. $$Root$$.clw
  89.     This file contains information used by ClassWizard to edit existing
  90.     classes or add new classes.  ClassWizard also uses this file to store
  91.     information needed to create and edit message maps and dialog data
  92.     maps and to create prototype member functions.
  93. $$IF(!PROJTYPE_DLL)
  94.  
  95. res\$$Root$$.ico
  96.     This is an icon file, which is used as the application's icon.  This
  97.     icon is included by the main resource file $$Root$$.rc.
  98. $$ENDIF //!PROJTYPE_DLL
  99.  
  100. res\$$Root$$.rc2
  101.     This file contains resources that are not edited by Microsoft
  102.     Visual C++.  You should place all resources not editable by
  103.     the resource editor in this file.
  104. $$IF(!PROJTYPE_DLL)
  105. $$IF(CONTAINER_SERVER || FULL_SERVER || MINI_SERVER || AUTOMATION || HAS_SUFFIX)
  106.  
  107. $$Root$$.reg
  108.     This is an example .REG file that shows you the kind of registration
  109.     settings the framework will set for you.  You can use this as a .REG
  110. $$IF(PROJTYPE_DLG)
  111.     file to go along with your application.
  112. $$ELSE //!DLG
  113.     file to go along with your application or just delete it and rely
  114.     on the default RegisterShellFileTypes registration.
  115. $$ENDIF //PROJTYPE_DLG
  116. $$ENDIF //OLE || HAS_SUFFIX
  117. $$IF(AUTOMATION)
  118.  
  119. $$Root$$.odl
  120.     This file contains the Object Description Language source code for the
  121.     type library of your application.
  122. $$ENDIF //AUTOMATION
  123. $$ENDIF //!PROJTYPE_DLL
  124. $$IF(PROJTYPE_DLL)
  125.  
  126. $$Root$$.def
  127.     This file contains information about the DLL that must be
  128.     provided to run with Microsoft Windows.  It defines parameters
  129.     such as the name and description of the DLL.  It also exports
  130.     functions from the DLL.
  131. $$ENDIF //PROJTYPE_DLL
  132.  
  133. $$IF(!PROJTYPE_DLL)
  134. $$IF(!PROJTYPE_DLG)
  135. /////////////////////////////////////////////////////////////////////////////
  136.  
  137. For the main frame window:
  138.  
  139. $$FRAME_HFILE$$.h, $$FRAME_IFILE$$.cpp
  140.     These files contain the frame class $$FRAME_CLASS$$, which is derived from
  141. $$IF(PROJTYPE_MDI)
  142.     CMDIFrameWnd and controls all MDI frame features.
  143. $$ELSE
  144.     CFrameWnd and controls all SDI frame features.
  145. $$ENDIF
  146.  
  147. $$IF(TOOLBAR)
  148. res\Toolbar.bmp
  149.     This bitmap file is used to create tiled images for the toolbar.
  150.     The initial toolbar and status bar are constructed in the $$FRAME_CLASS$$
  151.     class. Edit this toolbar bitmap using the resource editor, and
  152.     update the IDR_MAINFRAME TOOLBAR array in $$Root$$.rc to add
  153.     toolbar buttons.
  154. $$IF(MINI_SERVER || FULL_SERVER || CONTAINER_SERVER)
  155.  
  156. res\IToolbar.bmp
  157.     This bitmap file is used to create tiled images for the toolbar
  158.     when your server application is in-place activated inside another
  159.     container.  This toolbar is constructed in the $$IPFRAME_CLASS$$
  160.     class.  This bitmap is similar to the bitmap in res\Toolbar.bmp
  161.     except that it has many non-server commands removed.
  162. $$ENDIF //SERVER
  163. $$ENDIF //TOOLBAR
  164.  
  165. $$IF(LOGO_YES)
  166. RES\LOGO.BMP
  167.     This bitmap file is used to display your company logo on the dialog
  168.     window.
  169. $$ENDIF //LOGO
  170. $$IF(PROJTYPE_MDI)  //If an MDI app, it will contain a ChildFrm class
  171.  
  172. /////////////////////////////////////////////////////////////////////////////
  173.  
  174. For the child frame window:
  175.  
  176. ChildFrm.h, ChildFrm.cpp
  177.     These files define and implement the CChildFrame class, which
  178.     supports the child windows in an MDI application.
  179.  
  180. $$ENDIF //PROJTYPE_MDI
  181. /////////////////////////////////////////////////////////////////////////////
  182.  
  183. $$IF(!NODOCVIEW)
  184. $$IF(!DB_NO_FILE)
  185. AppWizard creates one document type and one view:
  186.  
  187. $$DOC_HFILE$$.h, $$DOC_IFILE$$.cpp - the document
  188.     These files contain your $$DOC_CLASS$$ class.  Edit these files to
  189.     add your special document data and to implement file saving and loading
  190.     (via $$DOC_CLASS$$::Serialize).
  191. $$ELSE
  192. AppWizard creates one view:
  193. $$ENDIF
  194.  
  195. $$VIEW_HFILE$$.h, $$VIEW_IFILE$$.cpp - the view of the document
  196.     These files contain your $$VIEW_CLASS$$ class.
  197. $$IF(!DB_NO_FILE)
  198.     $$VIEW_CLASS$$ objects are used to view $$DOC_CLASS$$ objects.
  199. $$ENDIF
  200. $$IF(CRecordView)
  201. //For an ODBC database app:
  202. $$RECSET_HFILE$$.h, $$RECSET_IFILE$$.cpp - the recordset
  203.     These files define and implement the recordset class $$RECSET_CLASS$$,
  204.     which performs database query and collection.
  205.  
  206. $$ENDIF
  207. $$IF(CDaoRecordView)
  208. //For a DAO database app:
  209. $$RECSET_HFILE$$.h, $$RECSET_IFILE$$.cpp - the recordset
  210.     These files define and implement the recordset class $$RECSET_CLASS$$,
  211.     which performs database query and collection.
  212.  
  213. $$ENDIF
  214. $$IF(PROJTYPE_MDI)
  215. res\$$DOC_IFILE$$.ico
  216.     This is an icon file, which is used as the icon for MDI child windows
  217.     for the $$DOC_CLASS$$ class.  This icon is included by the main
  218.     resource file $$Root$$.rc.
  219. $$ENDIF //MDI
  220. $$ENDIF
  221.  
  222. $$IF(CONTAINER || FULL_SERVER || MINI_SERVER || CONTAINER_SERVER)
  223. /////////////////////////////////////////////////////////////////////////////
  224.  
  225. AppWizard has also created classes specific to OLE
  226.  
  227. $$IF(CONTAINER || CONTAINER_SERVER)
  228. $$CNTRITEM_HFILE$$.h, $$CNTRITEM_IFILE$$.cpp - this class is used to
  229.     manipulate OLE objects.  OLE objects are usually displayed by your
  230.     $$VIEW_CLASS$$ class and serialized as part of your $$DOC_CLASS$$ class.
  231.  
  232. $$ENDIF
  233. $$IF(MINI_SERVER || FULL_SERVER || CONTAINER_SERVER)
  234. $$SRVRITEM_HFILE$$.h, $$SRVRITEM_IFILE$$.cpp - this class is used to
  235.     connect your $$DOC_CLASS$$ class to the OLE system, and optionally
  236.     provide links to your document.
  237. $$IPFRAME_HFILE$$.h, $$IPFRAME_IFILE$$.cpp - this class is derived
  238.     from COleIPFrameWnd and controls all frame features during
  239.     in-place activation.
  240. $$ENDIF
  241. $$ENDIF
  242. $$ELSE //!!PROJTYPE_DLG
  243.  
  244. /////////////////////////////////////////////////////////////////////////////
  245.  
  246. $$IF(AUTOMATION)
  247. AppWizard creates one dialog class and automation proxy class:
  248. $$ELSE //!AUTOMATION
  249. AppWizard creates one dialog class:
  250. $$ENDIF //AUTOMATION
  251.  
  252. $$DLG_HFILE$$.h, $$DLG_IFILE$$.cpp - the dialog
  253.     These files contain your $$DLG_CLASS$$ class.  This class defines
  254.     the behavior of your application's main dialog.  The dialog's
  255.     template is in $$Root$$.rc, which can be edited in Microsoft
  256.     Visual C++.
  257.  
  258. $$IF(AUTOMATION)
  259. $$DLGAUTOPROXY_HFILE$$.h, $$DLGAUTOPROXY_IFILE$$.cpp - the automation object
  260.     These files contain your $$DLGAUTOPROXY_CLASS$$ class.  This class
  261.     is called the "automation proxy" class for your dialog, because it
  262.     takes care of exposing the automation methods and properties that
  263.     automation controllers can use to access your dialog.  These methods
  264.     and properties are not exposed from the dialog class directly, because
  265.     in the case of a modal dialog-based MFC application it is cleaner and
  266.     easier to keep the automation object separate from the user interface.
  267. $$ENDIF //AUTOMATION
  268. $$IF(PRESS_ME_DIALOG)
  269. Custom AppWizard "My Logo AppWizard" copies over extra materials to handle
  270. the "Press Me" dialog:
  271.  
  272. PRESSDLG.H, PRESSDLG.CPP - the "Press Me" dialog
  273.     These files contain class CPressMeDlg.  This class implements the
  274.     "Press Me" dialog which is reached by pressing the "Press me" button
  275.     on your application's main dialog.  The dialog's template is in
  276.     $$ROOT$$.RC, which can be edited in Microsoft Visual C++.
  277.  
  278. RES\SMILEU.BMP, RES\SMILED.BMP, RES\SMILEF.BMP
  279. RES\FROWNU.BMP, RES\FROWND.BMP, RES\FROWNF.BMP
  280.     These bitmaps are used to draw the owner-draw buttons on the "Press Me"
  281.     dialog.  The first set of buttons is for the OK button.  The second set
  282.     is for the Cancel button.  For each set of buttons, the first one is
  283.     displayed when the button is in the 'up' position, the second one is
  284.     displayed when the button is in the 'down' position, and the last one is
  285.     displayed when the button has the focus.
  286.  
  287. $$ENDIF //PRESS_ME_DIALOG
  288. $$ENDIF //!PROJTYPE_DLG
  289. $$IF(HELP)
  290. /////////////////////////////////////////////////////////////////////////////
  291.  
  292. Help Support:
  293.  
  294. hlp\$$Root$$.hpj
  295.     This file is the Help Project file used by the Help compiler to create
  296.     your application's Help file.
  297.  
  298. hlp\*.bmp
  299.     These are bitmap files required by the standard Help file topics for
  300.     Microsoft Foundation Class Library standard commands.
  301.  
  302. hlp\*.rtf
  303.     This file contains the standard help topics for standard MFC
  304.     commands and screen objects.
  305. $$ENDIF //HELP
  306.  
  307. $$ENDIF //!PROJTYPE_DLL
  308. /////////////////////////////////////////////////////////////////////////////
  309. Other standard files:
  310.  
  311. StdAfx.h, StdAfx.cpp
  312.     These files are used to build a precompiled header (PCH) file
  313.     named $$Root$$.pch and a precompiled types file named StdAfx.obj.
  314.  
  315. Resource.h
  316.     This is the standard header file, which defines new resource IDs.
  317.     Microsoft Visual C++ reads and updates this file.
  318.  
  319. /////////////////////////////////////////////////////////////////////////////
  320. Other notes:
  321.  
  322. AppWizard uses "TODO:" to indicate parts of the source code you
  323. should add to or customize.
  324. $$IF(PROJTYPE_MDI || PROJTYPE_SDI || PROJTYPE_DLG)
  325.  
  326. If your application uses MFC in a shared DLL, and your application is
  327. in a language other than the operating system's current language, you
  328. will need to copy the corresponding localized resources MFC42XXX.DLL
  329. from the Microsoft Visual C++ CD-ROM onto the system or system32 directory,
  330. and rename it to be MFCLOC.DLL.  ("XXX" stands for the language abbreviation.
  331. For example, MFC42DEU.DLL contains resources translated to German.)  If you
  332. don't do this, some of the UI elements of your application will remain in the
  333. language of the operating system.
  334. $$ENDIF //MDI,SDI,DLG
  335.  
  336. /////////////////////////////////////////////////////////////////////////////
  337.