README for                                                          [Image]
OpenDoc Scriptable Simple Part Sample Part

---------------------------------------------------------------------------

Contents

   * 1. Files and their Uses in this Part
        o Files shipped as Source in the Package
        o Files shipped as Binary, or Built
   * 2. Functional Description of the ScriptableSimplePart Sample
        o Inherited Behaviour
        o Intrinsic Behaviour
   * 3. How to Install the ScriptableSimplePart Sample
   * 4. How to Build the ScriptableSimplePart Sample
   * 5. How to Execute the ScriptableSimplePart Sample
        o Using the editor
        o Using the OpenDoc® Documents
   * 6. How to Modify the ScriptableSimplePart Sample
        o Extending the Source
        o Subclassing the Binaries
   * 7. ScriptableSimplePart Design Notes
   * 8. Platform Dependance Issues
   * 9. GrafPart Known Bugs and Limitations

---------------------------------------------------------------------------

1. Files in this part

Files shipped as Source in the Package

The following files are shipped in the &OD. distribution as source, and are
required to rebuild the Scriptable Simple Part sample (without modification).
All of the following files are platform-independant, except as noted.
These files are located in the src/scrsimpl directory.

iodscrsp.txt
    This README file.  Describes the content of the ScriptableSimplePart
    distribution package.

iodscrs2.cpp
iodscrs2.h
opdspcl2.h
iodscrs2.idl
iodscrs2.xih
    These files provide the source, and SOM interface description for the
    Scriptable Simple Part.   Since this part inherits from the SimplePart
    only overriding logic is present in this code.

iodspex2.cpp
iodspex2.idl
iodspex2.xih
    These files provide the implementation of the ScriptExtension for the
    ScriptableSimplePart.  The class is based on the ODScriptExtension class
    and provides the interface between the part and the Lotus Scripting
    environment.

iodspevt.idl
    This virtual class provides the SOM defintions for the events that are
    raised by the ScriptableSimplePart.

makefile
iodscrs2.def
iodscrs2.mdf
iodscrs2.rc
iodscrs2.cin
    These files support the building of the ScriptableSimplePart class.  The
    makefile is designed to function in the sample build environment supplied
    with OpenDoc.  The .def, .mdf and .rc files provide declarations and
    definitions needed by the compiler and linkers. The .cin file is used
    as input to the OpenDoc utility, ctypelib.

iodscspd.ico
iodscspe.ico
iodscspl.ico
iodscsps.ico
    These platform specific icon defintions are used by the part during
    execution to present the 'icon view'.

iodscrs2.odt
iodscrs2.res
iodscrs2.tlb
    These files are built during the make process from other files in the
    package.  The binary forms are distributed for use during installation.


Back to the Table of Contents.
---------------------------------------------------------------------------

2. Function Description

Inherited Behaviours

ScriptableSimplePart2 inherits the bulk of its function from the SimplePart
and thus provides an example of the basic functions available in a part.
This part has been extended to provide an example of the coding requirements
for adding event support (MouseDown) and exposing methods (getColor, setColor).
It also illustrates the type of changes needed for a part which is to be
scriptable using the Lotus Script Component (menu items, extension support,
externalize and initialize support, etc).

Back to the Table of Contents.
---------------------------------------------------------------------------
3. How to Install the ScriptableSimplePart2 Sample

The ScriptableSimple2 part has been built and packaged using the package
structure defined for this release.  It is not normally installed during
OpenDoc installation but can be installed using the odinst command and
the iodscrs2.odz package file.

Back to the Table of Contents.
---------------------------------------------------------------------------

4. How to Build the ScriptableSimplePart2 Sample

The makefile and support files supplied with this part work with the
sample make environment that is supplied with OpenDoc.  Please see the
documentation for that build environment for details.

Back to the Table of Contents.
---------------------------------------------------------------------------

5. How to Execute the ScriptableSimplePart2 Sample

Using the editor
    The ScriptableSimplePart functions in the same way as the SimplePart.
    The Menu contains two additional entries - Edit Scripts - to initiate
    scripting associated with the part and Remove Scripts to remove the
    scripts that have been created.

Using the &OD. Documents
    Scripts that are developed for a part will remain with that part as
    it is saved/restored/moved/copied in the OpenDoc environment.  Thus
    scripted part becomes a customized version of the SimplePart.

Back to the Table of Contents.
---------------------------------------------------------------------------

6. How to Modify the ScriptableSimplePart2 Sample

Extending the Source
    The source may be modified as needed, perhaps to introduce additional
    methods, properties or events to be suported.

Subclassing the Binaries

Back to the Table of Contents.
---------------------------------------------------------------------------

7. ScriptableSimplePart2 Design Notes

   This package is one of three variations of the scriptable simple part
   which are included in the distribution package.  This version represents
   a different registration model than provided by ScriptableSimplePart and
   thus presents a slightly different view to the user.  Please see the
   comparison in the file iodscrsp.txt (i.e. the file that corresponds to
   this file for ScriptableSimplePart).

Back to the Table of Contents.
---------------------------------------------------------------------------

8. Platform Dependance Issues

    This part has only been tested in the Windows NT/95 envrionment though
    there is no reason to expect different behavior if it is compiled on
    other platforms.

Back to the Table of Contents.
---------------------------------------------------------------------------

9. ScriptableSimplePart2 Known Bugs and Limitations

Back to the Table of Contents.
---------------------------------------------------------------------------
©. 1996 IBM Corporation. All rights reserved.

Last updated: 97/02/20
