WPSProgRef - Workplace Object Classes

Workplace Shell Programming Reference
What's New How to Use this Book Workplace Object Classes Workplace Class Methods Workplace Instance Methods Presentation Manager Functions Related to the Workplace Shell Data Types Menu IDs Notices Glossary

Reprint Courtesy of International Business Machines Corporation, © International Business Machines Corporation

This chapter contains an alphabetic listing of the Workplace object classes.

These sections contain technical reference information. For information on the System Object Model (SOM), see the System Object Model Guide and Reference.

Object Classes

Workplace objects are icons representative of physical objects which users deal with in the Workplace. A Workplace object is implemented as an instance of a Workplace object class. Workplace object classes are System Object Model (SOM) object classes which are descendants of the predefined Workplace object class, WPObject. For more information about SOM object classes, see System Object Model Guide and Reference.

All Workplace objects are descendants of a Workplace object storage class. Workplace storage object classes are responsible primarily for storing and retrieving object class data for instances of objects which are descendants (subclasses) of that storage class.

The three predefined Workplace object storage classes are:

Storage Classes
Class Name	Description
WPAbstract	Storage class for objects stored in the user profile (OS2.INI)
WPFileSystem	Storage class for objects stored as files in the file system
WPTransient	Storage class for non-persistent objects.

Workplace Object Class Hierarchy

The following figure lists the predefined Workplace object classes in a hierarchical order. Each branch in the tree represents an immediate descendant (subclass) of a Workplace object class. The predefined SOM object class, SOMObject, is the root class for all SOM object classes, including all Workplace object classes.

   CLASS NAME                                    CLASS DEFINITION FILE

SOMObject somobj.idl

 ├───SOMClass                                         somcls.idl
 ├───SOMClassMgr                                      somcm.idl
 │    └─WPClassManager                                wpclsmgr.idl
 └───WPObject                                         wpobject.idl
       ┌─────WPAbstract                               wpabs.idl
       │     ├── WPClock                              wpclkm.idl
       │     ├── WPCountry                            wpctry.idl
       │     ├── WPDisk                               wpdisk.idl
       │     ├── WPLaunchPad                          wplnchpd.idl
       │     ├── WPKeyboard                           wpkeybd.idl
       │     ├── WPMouse                              wpmouse.idl
       │     ├── WPPalette                            wppalet.idl
       │     │     ├── WPColorPalette                 wpclrpal.idl
       │     │     ├── WPFontPalette                  wpfntpal.idl
       │     │     └── WPSchemePalette                wpscheme.idl
       │     ├── WPPower                              wppower.idl
       │     ├── WPPrinter                            wpprint.idl
       │     │     └── WPRPrinter                     wprprint.idl
       │     ├── WPProgram                            wppgm.idl
       │     ├── WPShadow                             wpshadow.idl
       │     │     └── WPNetLink                      wpnetlnk.idl
       │     ├── WPShredder                           wpshred.idl
       │     ├── WPSound                              wpsound.idl
       │     ├── WPSpecialNeeds                       wpspneed.idl
       │     ├── WPSpool                              wpspool.idl
       │     ├── WPSystem                             wpsystem.idl
       │     └── WPWinConfig                          wincfg.idl
       ├── WPFileSystem                               wpfsys.idl
       │     ├── WPDataFile                           wpdataf.idl
       │     │     ├── WPHtml                         wphtml.idl
       │     │     ├── WPIcon                         wpicon.idl
       │     │     ├── WPImageFile                    wpimage.idl
       │     │     │      └── WPBitmap                wpbitmap.idl
       │     │     ├── WPMet                          wpmet.idl
       │     │     ├── WPPif                          wppif.idl
       │     │     ├── WPPointer                      wpptr.idl
       │     │     ├── WPProgramFile                  wppgmf.idl
       │     │     │       └── WPCommandFile          wpcmdf.idl
       │     │     ├── WPUrl                          wpurl.idl
       │     ├── WPFolder                             wpfolder.idl
       │     │     ├── WPDesktop                      wpdesk.idl
       │     │     ├── WPDrives                       wpdrives.idl
       │     │     ├── WPHost                         wphost.idl
       │     │     ├── WPHwManager                    wphwmgr.idl
       │     │     ├── WPMinWinViewer                 wpmwv.idl
       │     │     ├── WPNetgrp                       wpnetgrp.idl
       │     │     ├── WPNetwork                      wpnetwrk.idl
       │     │     ├── WPRootFolder                   wprootf.idl
       │     │     ├── WPServer                       wpserver.idl
       │     │     ├── WPSharedDir                    wpshdir.idl
       │     │     ├── WPStartup                      wpstart.idl
       │     │     ├── WPTemplates                    wptemps.idl
       │     │     └── WPUrlFolder                    wpurlfdr.idl
       └── WPTransient                                wptrans.idl
             ┌── WPJob                                wpjob.idl
             ├── WPDevice                             wpdevice.idl
             │     ├── WPDevAudio                     wpaudio.idl
             │     ├── WPDevBus                       wpbus.idl
             │     ├── WPDevCDRom                     wpcdrom.idl
             │     ├── WPDevCPU                       wpcpu.idl
             │     ├── WPDevDiskette                  wpdskett.idl
             │     ├── WPDevDisplay                   wpdisply.idl
             │     ├── WPDevHarddrive                 wphrddrv.idl
             │     ├── WPDevKeyboard                  wpkeybdd.idl
             │     ├── WPDevMemory                    wpmem.idl
             │     ├── WPDevMouse                     wpmoused.idl
             │     ├── WPDevParallel                  wpparal.idl
             │     ├── WPDevPeriph                    wpperiph.idl
             │     ├── WPDevSerial                    wpserial.idl
             │     ├── WPDevTape                      wptape.idl
             │     └── WPDevTimer                     wptimer.idl
             ├── WPPort                               wpport.idl
             ├── WPPdr                                wppdr.idl
             └── WPQdr                                wpqdr.idl

Instances of some Workplace object classes cannot be created as a Workplace object. These classes are provided as base classes which provide support for descendant classes that can have instances created. Other classes are SOM classes and are described in better detail in the System Object Model Guide and Reference.

These classes include:

SOM Base Classes
Class Name	Description	Workplace Object Creation
SOMObject	This is the SOM root class. All SOM classes must be descended from SOMObject.	Cannot be created.
SOMClass	This is the SOM metaclass, that is, the instances of this class are class objects.	Cannot be created.
SOMClassMgr	This is the SOM class manager class.	Cannot be created.