Tizen 2.0 Release
[external/vim.git] / src / VisVim / VsReadMe.txt
1 ========================================================================
2        DEVELOPER STUDIO ADD-IN : VisVim
3 ========================================================================
4
5
6 The Add-in Wizard has created this VisVim DLL for you.  This DLL not only
7 demonstrates the basics of creating a Developer Studio add-in, but it is also
8 a starting point for writing your own add-in.
9
10 An add-in mainly does two things.
11         (1) It adds commands to Developer Studio, which can then be tied
12             to keystrokes or toolbar buttons by the user or programmatically
13                 by the add-in.
14         (2) It responds to events fired by Developer Studio.
15 In both cases, the add-in code has access to the full Developer Studio
16 Automation Object Model, and may manipulate those objects to affect the
17 behavior of Developer Studio.
18
19 This file contains a summary of what you will find in each of the files that
20 make up your VisVim DLL.
21
22
23 VisVim.h
24     This is the main header file for the DLL.  It declares the
25     CVisVimApp class.
26
27 VisVim.cpp
28     This is the main DLL source file.  It contains the class CVisVimApp.
29     It also contains the OLE entry points required of inproc servers.
30
31 VisVim.odl
32     This file contains the Object Description Language source code for the
33     type library of your DLL.
34
35 VisVim.rc
36     This is a listing of all of the Microsoft Windows resources that the
37     program uses.  It includes the sample toolbar bitmap that is stored
38     in the RES subdirectory.  This file can be directly edited in Microsoft
39     Developer Studio.
40
41 res\VisVim.rc2
42     This file contains resources that are not edited by Microsoft
43     Developer Studio.  You should place all resources not
44     editable by the resource editor in this file.
45
46 VisVim.def
47     This file contains information about the DLL that must be
48     provided to run with Microsoft Windows.  It defines parameters
49     such as the name and description of the DLL.  It also exports
50         functions from the DLL.
51
52 VisVim.clw
53     This file contains information used by ClassWizard to edit existing
54     classes or add new classes.  ClassWizard also uses this file to store
55     information needed to create and edit message maps and dialog data
56     maps and to create prototype member functions.
57
58 /////////////////////////////////////////////////////////////////////////////
59 Add-in-specific files:
60
61 DSAddIn.cpp, DSAddIn.h
62     These files contain the CDSAddIn class, which implements the
63     IDSAddIn interface.  This interface contains handlers
64     for connecting and disconnecting the add-in.
65
66 Commands.cpp, Commands.h
67     These files contain the CCommands class, which implements your
68     command dispatch interface.  This interface contains one method
69     for each command you add to Developer Studio.
70     These files also contain stub implementations of handlers for all events
71     fired by the Developer Studio Application object.
72
73 OleAut.cpp
74     These files contain a general OLE automation class used to communicate
75     with vim.
76
77 Reg.cpp
78     These files contain functions to access the registry.
79
80
81 /////////////////////////////////////////////////////////////////////////////
82 Other standard files:
83
84 StdAfx.h, StdAfx.cpp
85     These files are used to build a precompiled header (PCH) file
86     named VisVim.pch and a precompiled types file named StdAfx.obj.
87
88 Resource.h
89     This is the standard header file, which defines new resource IDs.
90     Microsoft Developer Studio reads and updates this file.
91