template.txt

EVC4.rar

    given class.</font></p>
</blockquote>

<blockquote>
    <p><font size="2"><b>CLASSNAME</b> &#150; specifies the class
    that contains the map</font></p>
    <p><font size="2"><b>map name </b>&#150; name of the map to
    add the entry to.</font></p>
    <p><font size="2"><b>map entry</b> &#150; the type of entry</font></p>
    <p><font size="2"><b>#of parameters</b> &#150; number of
    parameters in the entry.</font></p>
    <p><font size="2"><b>parameter1, ...</b> &#150; parameters to
    the entry. Max of 5 parameters.</font></p>
    <p><font size="2"><strong><u>Example.</u></strong></font></p>
    <p><font size="2">AddToMap(CONTROLCLASS, &quot;COM&quot;,
    &quot; COM_INTERFACE_ENTRY&quot;, &quot;1&quot;,
    &quot;ISomeInterface&quot;)</font></p>
    <p><font size="2">This will add the following line to the COM
    map in the class specified by CONTROLCLASS.</font></p>
    <p><font size="2">COM_INTERFACE_ENTRY(ISomeInterface)</font></p>
</blockquote>

<p><font size="2"><b>AddClassInclude([CLASSNAME |
&quot;classname&quot;], [INCLUDENAME | &quot;includename&quot;],
&quot;[h | cpp]&quot;)</b></font></p>

<blockquote>
    <p><font size="2">Add the include directive to the header or
    the implementation file associated with a specified class.</font></p>
    <p><font size="2"><b>CLASSNAME or classname </b>&#150; the
    class used to determine the file to put the directive in.
    This can be a symbol or a value.</font></p>
    <p><font size="2"><b>INCLUDENAME or includename</b> &#150;
    specified what to include</font></p>
    <p><font size="2"><b>h or cpp</b> &#150; specifies where to
    put the directive. h specifies the header file for the class.
    cpp specifies implementation file for the class.</font></p>
</blockquote>

<p><font size="2"><b>AddMemberFunction([CLASSNAME |
&quot;classname&quot;], &quot;function name&quot;, &quot;return
type&quot;, &quot;parameters&quot;, &quot;access&quot;,
TEMPLATEFILE, &quot;classwizfunc&quot;)</b></font></p>

<blockquote>
    <p><font size="2">Adds the specified member function to the
    class.</font></p>
    <p><font size="2"><b>CLASSNAME or classname</b> &#150; the
    class the function has to be added to.</font></p>
    <p><font size="2"><b>function name</b> &#150; name of the
    function to add</font></p>
    <p><font size="2"><b>return type</b> &#150; return type of
    the function</font></p>
    <p><font size="2"><b>parameters</b> &#150; parameters to the
    function</font></p>
    <p><font size="2"><b>access</b> &#150; can be one of the
    following.</font></p>
    <p><font size="2">ACCESS_PUBLIC &#150; adds the function as a
    public member function.</font></p>
    <p><font size="2">ACCESS_PROTECTED &#150; adds the function
    as a protected member function.</font></p>
    <p><font size="2">ACCESS_PRIVATE &#150; adds the function as
    a private member function.</font></p>
    <p><font size="2"><b>TEMPLATEFILE</b> &#150; specifies the
    template file that contains the body of the function.</font></p>
    <p><font size="2"><b>classwizfunc</b> &#150; indicates if the
    function declaration should be between classwizard comments. </font></p>
    <blockquote>
        <p><font size="2">If this is &quot;0&quot; then it is not
        a function that should be added between classwizard
        comments.<br>
        If it is &quot;1&quot; the it is added between the
        classwizard comments that pertain to virtual <b>functions.<br>
        </b>Any other value add it between the comments
        associated with class wizard message handler comments.</font></p>
    </blockquote>
</blockquote>

<p><font size="2"><b>AddMemberVariable([CLASSNAME |
&quot;classname&quot;], &quot;variable name&quot;, &quot;variable
type&quot;, &quot;access&quot;, &quot;unique variable&quot;[,
UNIQUEVARSYMBOL])</b></font></p>

<blockquote>
    <p><font size="2">Adds the specified member variable to the
    class.</font></p>
    <p><font size="2"><b>CLASSNAME</b> or classname &#150; the
    class the variable has to be added to.</font></p>
    <p><font size="2"><b>variable name</b> &#150; name of the
    variable to add</font></p>
    <p><font size="2"><b>variable type</b> &#150;type of variable</font></p>
    <p><font size="2"><b>access</b> &#150; can be one of the
    following.</font></p>
    <blockquote>
        <p><font size="2">ACCESS_PUBLIC &#150; adds the function
        as a public member variable.</font></p>
        <p><font size="2">ACCESS_PROTECTED &#150; adds the
        function as a protected member variable</font></p>
        <p><font size="2">ACCESS_PRIVATE &#150; adds the function
        as a private member variable.</font></p>
    </blockquote>
    <p><font size="2"><b>unique variable</b> &#150; indicates
    whether the variable has to be an unique symbol.</font></p>
    <blockquote>
        <p><font size="2">&quot;1&quot; indicates that the symbol
        has to be unique. requires the next parameter.</font></p>
        <p><font size="2">other values indicate that if a
        variable is already present then do nothing. Does not
        require the next parameter.</font></p>
    </blockquote>
    <p><font size="2"><b>UNIQUEVARSYMBOL</b> &#150; If a unique
    symbol first checks to see if the variable is already a
    member of the class. If not it add the variable and sets this
    symbol to value passed in. If the variable already exists
    then the wizard adds numbers after the given variable name
    till it finds a value that is unique and adds the variable to
    the class. On return this symbol will contain the value that
    was created and inserted into the class.</font></p>
</blockquote>

<p><font size="2"><b>AddToMemberFunction([CLASSNAME |
&quot;classname&quot;], function, TEMPLATEFILE, SYMBOL,
SEARCHTYPE[, &quot;search criteria&quot;])</b></font></p>

<blockquote>
    <p><font size="2">Adds code to a function depending onto
    search. When a string search fails the code is added to the
    end of the function.</font></p>
    <p><font size="2"><b>CLASSNAME or classname</b> &#150; the
    class the function is a member of. Use NULL for global
    functions.</font></p>
    <p><font size="2"><b>function</b> &#150; function to add code
    to.</font></p>
    <p><font size="2"><b>TEMPLATEFILE</b> &#150; template file
    that contains the code to be inserted.</font></p>
    <p><font size="2"><b>SYMBOL</b> &#150; this symbol is set to
    1 before the template file is processed and then removed
    after the processing is over. This allows a template file to
    contain code for different purposes all of them wrapped in
    different conditionals.</font></p>
    <p><font size="2"><b>SEARCHTYPE</b> &#150; can be one of the
    following.</font></p>
    <blockquote>
        <p><font size="2">BEGIN &#150; beginning of the function.
        Does not require the next parameter.</font></p>
        <p><font size="2">END &#150; end of the function. Does
        not require the next parameter.</font></p>
        <p><font size="2">LINEOFFSET &#150; a line offset from
        the beginning of the function. Next parameter is a number
        that gives the offset.</font></p>
    </blockquote>
    <p><font size="2"><b>AFTERSEARCH</b> &#150; Inserts on the
    line after the line that contains the search string. Next
    parameter is the string to search for. Search begins at the
    beginning of the function and the first match is used. If
    search fails the string is added to the end of the function.</font></p>
    <p><font size="2"><b>BEFORESEARCH</b> &#150; Inserts on the
    line before the line that contains the search string. Search
    begins at the beginning of the function and the first match
    is used. If search fails the string is added to the end of
    the function.</font></p>
    <p><font size="2"><b>search criteria</b> &#150; depends on
    the previous parameter.</font></p>
</blockquote>

<p><font size="2"><b>AddBaseClass(CLASSNAME, BASECLASS,
&quot;access&quot;)</b></font></p>

<blockquote>
    <p><font size="2">Adds a class as a base class to the
    specified class.</font></p>
    <p><font size="2"><b>CLASSNAME</b> &#150; the class to which
    the baseclass is to be added</font></p>
    <p><font size="2"><b>BASECLASS</b> &#150; the class to be
    added as the base class</font></p>
    <p><font size="2"><b>access</b> &#150; This is ignored. The
    class is added as public.</font></p>
</blockquote>

<p><font size="2"><b>ExistsMemberFunction([CLASSNAME |
&quot;classname&quot;], &quot;function prototype&quot;, SYMBOL)</b></font></p>

<blockquote>
    <p><font size="2">Checks if a function is a member of the
    specified class.</font></p>
    <p><font size="2"><b>CLASSNAME or classname</b> &#150; The
    class that should contain the member function. Use NULL for
    global functions.</font></p>
    <p><font size="2"><b>function prototype</b> &#150; prototype
    of the function to check</font></p>
    <p><font size="2"><b>SYMBOL</b> &#150; this symbol is set to
    &quot;1&quot; if the function is a member otherwise it is set
    to &quot;0&quot;.</font></p>
</blockquote>

<p><font size="2"><strong>ExistsInMemberFunction([CLASSNAME |
&quot;classname&quot;], &quot;function prototype&quot;,
&quot;search string&quot;, SYMBOL)</strong></font></p>

<blockquote>
    <p><font size="2">Checks if a function contains the specified
    string.</font></p>
    <p><font size="2"><b>CLASSNAME or classname </b>&#150; the
    class the function is a member of. Use NULL for global
    functions.</font></p>
    <p><font size="2"><b>function prototype</b> &#150; prototype
    of the function to search in.</font></p>
    <p><font size="2"><b>search string</b> &#150; string to
    search for</font></p>
    <p><font size="2"><b>SYMBOL</b> &#150; this symbol is set to
    &quot;1&quot; if the search succeeds otherwise it is set to
    &quot;0&quot;.</font></p>
</blockquote>

<p><font size="2"><b>IDLSettingsForATL()</b></font></p>

<blockquote>
    <p><font size="2">Modifies the settings for an IDL/ODL
    already in the project to match the settings required for
    using ATL in the project.</font></p>
</blockquote>

<p><font size="2"><b>OpenDialog(DIALOGID)</b></font></p>

<blockquote>
    <p><font size="2">Opens a dialog in the dialog editor after
    the wizard exists.</font></p>
</blockquote>

<blockquote>
    <p><font size="2"><b>DIALOGID</b> &#150; the id of the dialog
    to open.</font></p>
</blockquote>

<p><font size="2"><b>Commit()</b></font></p>

<blockquote>
    <p><font size="2">Commits changes made by the wizard till
    that point. Changes made before this directive will not
    undone if the wizard fails after this directive. This
    directive commits all the changes before it so the changes
    can be accessed in the wizard. This is used by the Dialog
    wizard to open the dialog resource. Any change made by the
    wizard will not be accessible in the wizard till they are
    committed by this directive.</font></p>
</blockquote>

<p><font size="4"><b><u>PropertyPages</u></b></font></p>

<p><font size="2">Property pages can be created to allow
customization of the object being inserted. The wizard creates a
property sheet using the OleCreatePropertyFrame API. The property
pages that are displayed using this property sheet should support
the IPropertyPage interface.</font></p>

<p><font size="2">Property pages can communicate with the wizard
using the ISymbolMap interface implemented by the wizard. </font></p>

<p><font size="3"><b>ISymbolMap</b></font></p>

<p><font size="2">In addition to the IUnknown methods it
implements the following.</font></p>

<p><font size="2"><b>HRESULT Set(/* [in] */ LPCOLESTR strSymbol,
/* [in] */ LPCOLESTR strValue);</b></font></p>

<blockquote>
    <p><font size="2">Adds the symbol string pair to the internal
    map of the wizard</font></p>
</blockquote>

<blockquote>
    <p><font size="2">Returns S_OK</font></p>
</blockquote>

<p><font size="2"><b>HRESULT Get(/* [in] */ LPCOLESTR strSymbol,
/* [retval][out] */ BSTR *pstrValue);</b></font></p>

<blockquote>
    <p><font size="2">Retrieves the value associated with the
    specified symbol. If the call is successful pstrValue will
    point to a BSTR which is allocated using SysAllocString. The
    caller should free this string using SysFreeString</font></p>
    <p><font size="2">Returns S_OK if it finds the symbol. E_FAIL
    if the symbol is not found.</font></p>
</blockquote>

<p><font size="2"><b>HRESULT STDMETHODCALLTYPE Clear(void) ;</b></font></p>

<blockquote>
    <p><font size="2">Clears all the internal map of the wizard
    of all symbols.</font></p>
</blockquote>

<p><font size="2"><b>HRESULT SetStatus(const CLSID *pclsid, BOOL
bEnableOK);</b></font></p>

<blockquote>
    <p><font size="2">Allows each individual property pages to
    specify if the OK button can be enabled to allow the user to
    complete their selections. This is useful when the OK button
    has to be disabled till the user has entered some required
    values.</font></p>
    <p><font size="2"><strong>pcslid</strong> points to the CLSID
    of the property page that is calling this method. </font></p>
    <p><font size="2"><strong>bEnableOK</strong> specifies
    whether the OK button should be enable or disabled. TRUE
    specifies enable.</font></p>
</blockquote>

<p><font size="2">ISymbolMap can be obtained by Querying the
IUnknown passed through SetObjects method of IPropertyPage.</font></p>

<p><font size="4"><b><u>Existing Property Pages</u></b></font></p>

<p><font size="2">Following are some of the existing property
pages.</font></p>

<p><font size="2"><b><u>Names Property Page</u></b></font></p>

<p><font size="2">Sets the following symbols. ProgID is
&quot;Names98&quot;. The symbol ComponentType controls
enabling/disabling controls. This is a string with each character
representing the field in the tab order. Each char should be
either 0 or 1.</font></p>

<p><font size="2"></font>&nbsp;</p>

<table border="1" cellpadding="9" width="100%"
bordercolor="#000000">
    <tr>
        <td valign="top" width="32%" bgcolor="#808080"><font
        color="#FFFFFF" size="2"><b>Symbol</b></font></td>
        <td valign="top" width="68%" bgcolor="#808080"><font
        color="#FFFFFF" size="2"><b>Contents of field on the
        Property Page that is used for value</b></font></td>
    </tr>
    <tr>
        <td valign="top" width="32%"><font size="2">ShortName </font></td>
        <td valign="top" width="68%"><font size="2">Short Name</font></td>
    </tr>
    <tr>
        <td valign="top" width="32%"><font size="2">ClassName</font></td>
        <td valign="top" width="68%"><font size="2">Class</font></td>
    </tr>