home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / opendc12.zip / od124os2.exe / od12osp1.exe / src / basecntr / iodbasec.txt < prev    next >
Text File  |  1997-04-02  |  6KB  |  122 lines
  1. Description:
  2.  
  3.     The BaseContainer part is a subclassable sample part which demonstrates
  4.     several OpenDoc protocols such as registration, embedding, internalization,
  5.     externalization, cloning, multiple selection, drag/drop, and clipboard
  6.     operations.  It is available on the Windows 95/NT, OS/2, and AIX platforms.
  7.  
  8.     The BaseContainer part does not have intrinsic contents.  Its contents
  9.     include only embedded frames.  Subclasses of BaseContainer can define/add
  10.     intrinsic contents and let BaseContainer handle them optionally using its
  11.     generic 'Content Object' class.
  12.  
  13. Files:
  14.  
  15.     iodbasec.txt  --  This file
  16.     iodbasec.idl  --  SOM IDL definitions for SOM class BaseContainer
  17.                       and metaclass M_BaseContainer
  18.     iodbasec.cpp  --  Class member functions
  19.     bcevent.cpp   --  Event handler functions
  20.     bcxfer.cpp    --  Data transfer functions
  21.     bcmain.h      --  Header file
  22.     iodbcobj.idl  --  SOM IDL definition for SOM class ContentObject and its
  23.                       subclass ContentFrame.
  24.     iodbcobj.cpp  --  Member functions for ContentObject and ContentFrame
  25.     iodbcutl.idl  --  SOM IDL definition for linked list class ALinkedList.
  26.     iodbcutl.cpp  --  Class member functions for ALinkedList
  27.     iodbcitr.idl  --  SOM IDL definition for embedded frames iterator
  28.                       class BCIterator.
  29.     iodbcitr.cpp  --  Class member functions for BCIterator
  30.     iodbcset.idl  --  SOM IDL definition for ODSettingsExtension subclass
  31.                          BCPageSettingsExt.
  32.     iodbcset.cpp  --  Class member functions for BCPartSettingsExt
  33.     iodbcpag.idl  --  SOM IDL definition for ODPropertyPage subclass 
  34.                          BaseContainerPage (AIX only).
  35.     iodbcpag.cpp  --  Class member functions for BaseContainerPage (AIX only).
  36.     iodbcvwt.cpp  --  BaseContainer private methods for ViewType support.
  37.     iodbcres.h    --  Header file containing resource ids (OS/2 and NT only)
  38.     os2plat.cpp   --  Helper functions (OS/2 only)
  39.     iodbasec.msg  --  English message file
  40.     iodbasec.def  --  Library definitions (platform specific)
  41.     iodbasec.rc   --  Resource file (NT and OS/2 only)
  42.     iodbasec.ico  --  Document Icon File (platform specific)
  43.     iodbcsta.ico  --  Stationery Icon File (NT only)
  44.     iodbcedt.ico  --  Editor Icon File (NT only)
  45.     makefile      --  NMAKE file (To build part run: nmake)
  46.  
  47.  
  48. How to Build:
  49.  
  50.     To build this part you will need the OpenDoc Release 1.1 toolkit.
  51.  
  52.     From the basecntr source directory run
  53.  
  54.     nmake
  55.  
  56.     To register the part with OpenDoc, run
  57.  
  58.     nmake ForceRegistry
  59.  
  60. Usage:
  61.  
  62.     To run the BaseContainer, issue the command:
  63.        docshell
  64.     and select "IBM BaseContainer Kind" from the dialog box.
  65.  
  66.     Other parts can now be embedded in the BaseContainer.
  67.     Following editing operations can be performed on BaseContainer:
  68.  
  69.     Embed -- Click on "Embed" pull-down menu of base container. A list
  70.              of all part handlers that are installed on the system is
  71.              displayed.  This list is created dynamically when base
  72.              container is loaded.  Select a part handler and click in
  73.              base container's client area to embed a part.  BaseContainer
  74.              allows multiple levels of embedding.
  75.  
  76.     Select -- An embedded part can be selected by 4 ways
  77.              1) Activate the embedded part and click on its activation border
  78.              2) If the embedded part is not active then Shift-Click or
  79.                 Ctrl-Click on it
  80.              3) Lasso selection: Hold and drag left mouse button down in
  81.                 BaseContainer's client area to get a selection rectangle.
  82.                 All the embeds that are in the selection rectangle when the
  83.                 mouse button is released are selected
  84.              4) Use 'Select All' menu option from 'Edit' menu.
  85.  
  86.              BaseContainer allows multiple selection.  Upon Ctrl-Click or
  87.              Shift-Click the selection state of the embed is toggled.
  88.              When the part is deactivated, all the selected parts are deselected.
  89.  
  90.     Move --  Selection can be moved using the selection border.  One cannot
  91.              move the selection outside the container's boundaries. A single
  92.              selected part can also be moved using 'Move' menu item in 'Edit'
  93.              menu.
  94.  
  95.     Resize -- A selected part can be resized by stretching its corner or edge
  96.              selection handles.  One can also use 'Resize' menu option from
  97.              'Embed' menu.
  98.  
  99.     Delete -- Use 'Delete Selection' menu option from 'Edit' menu
  100.  
  101.     Copy/Paste -- To copy selection, use 'Copy' menu option form 'Edit' menu.
  102.               To paste clipboard contents, select 'Paste' menu and then click
  103.               in client area of the active BaseContainer.
  104.  
  105.     Drag/Drop -- Press drag-mouse-button in the client area of selection and
  106.               drag it to the desired location either in same docshell or
  107.               another one.  Modifier keys can be used to force a drag-copy or
  108.               a drag-move.
  109.  
  110. Design Notes:
  111.    For information on how to subclass from the BaseContainer and
  112.    the ContentObject classes, see appendix D of the "IBM OpenDoc
  113.    Programming Guide."
  114.  
  115. Known Restrictions:
  116.  
  117.     BaseContainer does not allow "Open As Window" functionality.
  118.     BaseContainer supports icon views, however, the thumbnail view is
  119.     not fully implemented yet. At this time it just displays a large icon
  120.     on a thumbnail size frame.
  121.  
  122.