OS/2 Shareware BBS: 8 Other

home *** CD-ROM | disk | FTP | other *** search

/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / SOMINF.ZIP / SOMWPS.INF (.txt) < prev next >

Wrap

OS/2 Help File | 1992-05-13 | 59KB | 2,452 lines

ΓòÉΓòÉΓòÉ 1. Introduction to the Workplace Shell' ΓòÉΓòÉΓòÉ o The Workplace Shell under OS/2 2.0 introduces an object oriented layer into the Presentation Manager environment. o A mechanism is provided for registration of object classes, creation of objects of the registered classes and the inheritance of characteristics and behaviors from existing classes. o A Workplace Shell application my be created as a series of interactive objects on the desktop. o Each object possesses data and a set of methods that may be defined for the entire class or for each instance of that object. o The Workplace Shell objects are based on the System Object Model (SOM) which establishes a basic inheritance hierarchy for objects in the system. ΓòÉΓòÉΓòÉ 2. Objects in the Workplace Shell ΓòÉΓòÉΓòÉ o SOM provides the base hierarchy from which all other objects are descended o Workplace Shell extends this hierarchy by creating a number of classes of its own based on the SOMObject class. CLASS NAME CLASS DEFINITION FILE SOMObject somobj.sc Γö£ΓöÇΓöÇ SOMClass somcls.sc Γö£ΓöÇΓöÇ SOMClassMgr somcm.sc ΓööΓöÇΓöÇ WPObject wpobject.sc Γö£ΓöÇΓöÇ WPAbstract wpabs.sc Γöé Γö£ΓöÇΓöÇ WPClock wpclock.sc Γöé Γö£ΓöÇΓöÇ WPCountry wpctry.sc Γöé Γö£ΓöÇΓöÇ WPDisk wpdisk.sc Γöé Γö£ΓöÇΓöÇ WPKeyboard wpkeybd.sc Γöé Γö£ΓöÇΓöÇ WPMouse wpmouse.sc Γöé Γö£ΓöÇΓöÇ WPPalette wppalet.sc Γöé Γöé Γö£ΓöÇΓöÇ WPColorPalette wpclrpal.sc Γöé Γöé Γö£ΓöÇΓöÇ WPFontPalette wpfntpal.sc Γöé Γöé ΓööΓöÇΓöÇ WPSchemePalette wpscheme.sc Γöé Γö£ΓöÇΓöÇ WPPrinter wpprint.sc Γöé Γö£ΓöÇΓöÇ WPProgram wppgm.sc Γöé Γö£ΓöÇΓöÇ WPShadow wpshadow.sc Γöé Γö£ΓöÇΓöÇ WPShredder wpshred.sc Γöé Γö£ΓöÇΓöÇ WPSound wpsound.sc Γöé Γö£ΓöÇΓöÇ WPSpecialNeeds wpspneed.sc Γöé Γö£ΓöÇΓöÇ WPSpooler wpspool.sc Γöé ΓööΓöÇΓöÇ WPSystem wpsystem.sc Γö£ΓöÇΓöÇ WPFileSystem wpfsys.sc Γöé Γö£ΓöÇΓöÇ WPDataFile wpdataf.sc Γöé Γö£ΓöÇΓöÇ WPFolder wpfolder.sc Γöé Γöé Γö£ΓöÇΓöÇ WPDesktop wpdesk.sc Γöé Γöé Γö£ΓöÇΓöÇ WPDrives wpdrives.sc Γöé Γöé Γö£ΓöÇΓöÇ WPStartup wpstart.sc Γöé Γöé ΓööΓöÇΓöÇ WPTemplateFolder wptemps.sc Γöé ΓööΓöÇΓöÇ WPProgramFile wppgmf.sc ΓööΓöÇΓöÇ WPTransient wptrans.sc Γö£ΓöÇΓöÇ WPJob wpjob.sc Γö£ΓöÇΓöÇ WPPort wpport.sc Γö£ΓöÇΓöÇ WPPrinterDriver wppdr.sc ΓööΓöÇΓöÇ WPQueueDriver wpqdr.sc o As well as being descended from SOM's base inheritance hierarchy, all Workplace Shell object classes are descended from one of three base storage classes: WPAbstract - is the base for abstract objects such as programs, devices, etc. Control information for these objects is stored in OS2.INI. WPFileSystem - is the base class for objects that are stored as files in the file system. Control information for these objects is stored in the file system as extended attributes. WPTransient - is the base class for objects that only exist during execution of a particular program. These objects are alive only for a particular processing purpose. ΓòÉΓòÉΓòÉ 3. Object Behavior ΓòÉΓòÉΓòÉ o The behavior of an object in the Workplace Shell is similar to that of a window under PM. - The object must have its class registered. - An instance of the class must be instantiated in the system. - The instance then receives messages and uses its methods to process those messages. o A significant difference is that, normally, a Workplace Shell object is persistent, while a PM window only exists for the duration of the program's execution. ΓòÉΓòÉΓòÉ 4. Creating a Workplace Shell object. ΓòÉΓòÉΓòÉ o A new object in the Workplace Shell is generally created by subclassing an existing object, then registering that object with the Workplace Shell. Registration is accomplished after a class has been built and placed into a DLL by calling the WinRegisterObjectClass function. This function records the name of the object class and the name of the DLL that contains the implentation code. o Class data is owned by the object class, not an instance of the class, and needs to be initialized before any instances of the class are created. - Class data is initialized by the _wpclsInitData method, which is called by the system when the class is loaded. - Any resources loaded during initialization should be freed when _wpclsUnInitdata is called as a class is being deregistered. o Once an object class has been registered with the Workplace Shell, an instance of that object may be created (instantiated). This is accomplished by using the WinCreateObject function. This function takes as parameters info that will be used to setup the instance being created. o Instance data is initialized by the _wpInitData function, which is called when the object is created or awakened from a dormant state. o Resources allocated during initialization should be freed when _wpUnInitData is called as the object is put back into a dormant state. ΓòÉΓòÉΓòÉ 5. Opening and Closing Workplace Shell objects. ΓòÉΓòÉΓòÉ o When an object is opened, the _wpOpen method is invoked by the Workplace Shell. This method may be overridden to perform class specific processing. An object may be opened automatically when it is created by using the OPEN= keyword in the setup string passed when WinCreateObject is called o When an object is closed, the _wpClose method is invoked. This method may be overridden if it is necessary to perform any class specific processing for closing views o Because objects are generally persistent, it is necessary to save instance data so that the object may be opened in the same state in which it was closed. This may be accomplished by overriding the _wpSaveState and _wpRestoreState methods. A number of predefined methods are available for use when these are invoked such as _wpSaveString and _wpRestoreString. o An instance of an object may be destroyed by the user dropping the object on the shredder. If an application wishes to destroy an object, it may call the WinDestroyObject function passing the handle that was obtained when WinCreateObject was called. o An object class may be removed from the system by calling the WinDeregisterObjectClass function. However, it is then necessary to remove the object's DLL from the system LIBPATH. It may require a re-boot to accomplish this. ΓòÉΓòÉΓòÉ 6. Workplace Shell usage notes. ΓòÉΓòÉΓòÉ o A Workplace Shell object may access PM resources such as icons, bitmaps, dialogs, etc. However, this requires that the object obtain the module handle of the DLL that contains these resources. This would normally be accomplished during class initialization (_wpclsInitData), then the handles would be stored in class or global variables. o All Workplace Shell objects run in a SINGLE process. It is possible for an error in an object to cause the Workplace Shell to terminate. The Workplace Shell will restart itself, but, any processing that was occurring at the time of termination will be halted. It is recommended that any lengthy or critical processing be implemented using multiple processes. Other processes are NOT affected by an abend of the Workplace Shell. ΓòÉΓòÉΓòÉ 7. Workplace Shell Objects: Base and Storage classes ΓòÉΓòÉΓòÉ ΓòÉΓòÉΓòÉ 7.1. The WPObject class ΓòÉΓòÉΓòÉ Class definition file: wpobject.sc Class hierarchy SOMObject WPObject Description This is the root Workplace object class. This is the fundamental class from which all workplace objects are derived, irrespective of where they are actually stored. Immediate descendant classes of WPObject are called storage classes, since they take responsibility for storing the object information, typically in a persistent form. Predefined workplace object storage classes are: WPAbstract WPFileSystem WPTransient A Workplace object of this class cannot be created. Instance methods The following lists show how all the WPObject instance methods are related within functional areas. Settings notebook methods wpAddObjectGeneralPage wpAddSettingsPages wpInsertSettingsPage Save/restore state methods wpRestoreData wpRestoreLong wpRestoreState wpRestoreString wpSaveData wpSaveImmediate wpSaveLong wpSaveState wpSaveString Object usage methods wpAddToObjUseList wpDeleteFromObjUseList wpFindUseItem wpUnlockObject Popup menu methods wpClose wpCopyObject wpCreateFromTemplate wpCreateShadowObject wpDelete wpDisplayHelp wpFilterPopupMenu wpHide wpInsertPopupMenuItems wpMenuItemHelpSelected wpMenuItemSelected wpModifyPopupMenu wpMoveObject wpOpen wpPrintObject wpRestore Query and Set object information methods wpQueryConfirmations wpQueryDefaultHelp wpQueryDefaultView wpQueryDetailsData wpQueryIcon wpQueryIconData wpQueryStyle wpQueryTitle wpSetDefaultHelp wpSetDefaultView wpSetIcon wpSetIconData wpSetStyle wpSetTitle Error handling methods wpQueryError wpSetError Memory management methods wpAllocMem wpFreeMem Setup/cleanup methods wpFree wpInitData wpScanSetupString wpSetup wpUnInitData Direct manipulation methods wpDragOver wpDraggedOverObject wpDrop wpDroppedOnObject wpEndConversation wpFormatDragItem wpRender wpRenderComplete Miscellaneous methods wpCnrInsertObject wpCnrRemoveObject wpCnrSetEmphasis wpConfirmDelete wpCopiedFromTemplate wpDoesObjectMatch wpRegisterView wpSwitchTo SOMObject methods The following lists show all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class. somFree somInit somUninit Class Methods The following list shows all the WPObject class methods. wpclsCreateDefaultTemplates wpclsFindObjectEnd wpclsFindObjectFirst wpclsFindObjectNext wpclsInitData wpclsMakeAwake wpclsNew wpclsQueryDefaultHelp wpclsQueryDefaultView wpclsQueryDetails wpclsQueryDetailsInfo wpclsQueryError wpclsQueryFolder wpclsQueryIcon wpclsQueryIconData wpclsQueryObject wpclsSetError wpclsQuerySettingsPageSize wpclsQueryStyle wpclsQueryTitle wpclsUnInitData SOMObject methods The following lists show all the class methods overridden by the WPObject class. These methods are overridden in order to modify the behavior defined by ancestor class. somUnInit SOMClass methods somInitClass somNew somRenew ΓòÉΓòÉΓòÉ 7.2. The WPAbstractClass ΓòÉΓòÉΓòÉ Class definition file: wpabs.sc Class hierarchy SOMObject WPObject WPAbstract Description This is the abstract object storage class. The storage medium for objects that are descendants of the WPAbstract class is the INI file. In other words, any object class derived from WPAbstract will have persistent storage for its instance variables in the INI file. Note that an abstract object does not have a file name, just a numeric handle that can be used to identify it. An instance of this class can be created as a Workplace object. There are no instances of this class initially created by the system. Instance methods There are currently no methods defined for the WPAbstract Workplace object class. WPObject instance methods The following list shows all the methods overridden by the WPAbstract class. These methods are overridden in order to modify the behavior defined by an ancestor class. wpCopyObject wpCreateFromTemplate wpSaveImmediate wpSaveState wpRestoreState wpMoveObject wpQueryIconData wpSetIconData wpSetTitle Class methods The following shows the class methods overridden by the WPAbstract class. These methods are overridden to modify the behavior defined by an ancestor class. WPObject class methods. wpclsQueryTitle ΓòÉΓòÉΓòÉ 7.3. The WPFileSystem class ΓòÉΓòÉΓòÉ Class definition file: wpfsys.sc Class hierarchy SOMObject WPObject WPFileSystem Description This is the file system object storage class. WPFileSystem is the storage class that represents all file system objects including directory (folder), data file, executable file, and root directory (drive) objects. This class also provides persistent storage of instance variables for all classes derived from it. A Workplace object of this class cannot be created. Instance methods The following list shows all the WPFileSystem class methods. wpAddFileMenuPage wpAddFile1Page wpAddFile2Page wpAddFile3Page wpQueryHandle wpQueryRealName wpQueryType wpSetRealName wpSetType WPObject instance methods The following list shows all the methods overridden by the WPFileSystem class. These methods are overridden in order to modify the behavior defined by an ancestor class. wpAddSettingsPages wpCopyObject wpCreateFromTemplate wpDoesObjectMatch wpDraggedOverObject wpDroppedOnObject wpFilterPopupMenu wpFormatDragItem wpMenuItemSelected wpModifyPopupMenu wpMoveObject wpOpen wpQueryDetailsData wpQueryIconData wpRestoreState wpSaveImmediate wpSaveState wpSetIconData wpSetTitle wpUnInitData Class methods The following list shows the wpFileSystem class methods. wpclsQueryInstanceFilter wpclsQueryInstanceType WPObject class methods. The following list shows all the class methods overridden by the WPFileSystem class. These methods are overridden to modify the behavior defined by an ancestor class. wpclsInitData wpclsQueryDetailsInfo wpclsQueryIconData wpclsQueryTitle ΓòÉΓòÉΓòÉ 7.4. The WPTransient class ΓòÉΓòÉΓòÉ Class definition file: wptrans.sc Class hierarchy SOMObject WPObject WPTransient Description This is the non-persistent object storage class. The WPTransient class is a storage class with no storage medium. That means that instances of object classes derived from WPTransient do not persist across reboots. This class is available for applications which need to utilize a large amount of workplace functionality (such as context menus and settings notebooks) in their object class without having to be a file, directory or a record in the INI file. An instance of this class can be created as a Workplace object. There are no instances of this class initially created by the system. Instance methods There are currently no methods defined for the WPTransient Workplace object class. WPObject instance methods The following list shows all the methods overridden by the WPTransient class. These methods are overridden in order to modify the behavior defined by an ancestor class. wpCopyObject Class methods The following list shows all the class methods overridden by the WPTransient class. These methods are overridden to modify the behavior defined by an ancestor class. WPObject class methods. wpclsQueryIconData wpclsQueryStyle wpclsQueryTitle ΓòÉΓòÉΓòÉ <hidden> wpAddObjectGeneralPage ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddObjectGeneralPage instance */ /* method is called to allow the object to */ /* add the General page to its settings */ /* notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndNotebook; ULONG ulRetCode; /* Page identifier */ ulRetCode = _wpAddObjectGeneralPage(self, hwndNotebook); ΓòÉΓòÉΓòÉ <hidden> wpAddSettingsPages ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddSettingsPages instance method */ /* is called to allow the object to add */ /* all of its settings pages to its */ /* settings notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndNotebook; BOOL fSuccess; /* Success indicator */ fSuccess = _wpAddSettingsPages(self, hwndNotebook); ΓòÉΓòÉΓòÉ <hidden> wpInsertSettingsPage ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpInsertSettingsPage instance */ /* method is called to insert a page into */ /* the object's settings notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndNotebook; PPAGEINFO ppageinfo; ULONG ulRetid; /* Page identifier */ ulRetid = _wpInsertSettingsPage(self, hwndNotebook, ppageinfo); ΓòÉΓòÉΓòÉ <hidden> wpRestoreData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRestoreData instance method is */ /* called to allow the object to restore */ /* its binary instance data. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszClass; ULONG ulKey; PBYTE pbValue; PULONG cbValue; BOOL fSuccess; /* Success indicator */ fSuccess = _wpRestoreData(self, pszClass, ulKey, pbValue, cbValue); ΓòÉΓòÉΓòÉ <hidden> wpRestoreLong ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRestoreLong instance method is */ /* called to allow the object to restore a */ /* 32-bit instance data value. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszClass; ULONG ulKey; PULONG pValue; BOOL fSuccess; /* Success indicator */ fSuccess = _wpRestoreLong(self, pszClass, ulKey, pValue); ΓòÉΓòÉΓòÉ <hidden> wpRestoreState ΓòÉΓòÉΓòÉ /*******************************************/ /* This method restores the state of the */ /* object which was saved during the */ /* processing of the wpSaveState method. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulReserved; BOOL fReturn; /* Success indicator */ fReturn = _wpRestoreState(self, ulReserved); ΓòÉΓòÉΓòÉ <hidden> wpRestoreString ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRestoreString instance method is */ /* called to allow the object to restore */ /* an ASCIIZ instance data string. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszClass; ULONG ulKey; PSZ pszValue; PULONG pulValue; BOOL fSuccess; /* Success indicator */ fSuccess = _wpRestoreString(self, pszClass, ulKey, pszValue, pulValue); ΓòÉΓòÉΓòÉ <hidden> wpSaveData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSaveData instance method is */ /* called to allow an object to save its */ /* binary instance data. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszClass; ULONG ulKey; PBYTE pbValue; ULONG ulValue; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSaveData(self, pszClass, ulKey, pbValue, ulValue); ΓòÉΓòÉΓòÉ <hidden> wpSaveImmediate ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSaveImmediate instance method is */ /* called to allow the object to save its */ /* current state. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; /* The pointer to this object */ BOOL fReturn; /* Success indicator */ fReturn = _wpSaveImmediate(self); ΓòÉΓòÉΓòÉ <hidden> wpSaveLong ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSaveLong instance method is */ /* called to allow the object to save a */ /* 32-bit instance data value. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszClass; ULONG ulKeyle; ULONG ulValue; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSaveLong(self, pszClass, ulKeyle, ulValue); ΓòÉΓòÉΓòÉ <hidden> wpSaveState ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSaveState instance method is */ /* called to allow the object to save its */ /* state. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSaveState(self); ΓòÉΓòÉΓòÉ <hidden> wpSaveString ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSaveString instance method is */ /* called to allow the object to save an */ /* ASCIIZ instance data string. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszClass; ULONG ulKey; PSZ pszValue; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSaveString(self, pszClass, ulKey, pszValue); ΓòÉΓòÉΓòÉ <hidden> wpAddToObjUseList ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddToObjUseList instance method */ /* is called to add a item type to an */ /* object's in-use list. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PUSEITEM pUseItem; BOOL fSuccess; /* Success indicator */ fSuccess = _wpAddToObjUseList(self, pUseItem); ΓòÉΓòÉΓòÉ <hidden> wpDeleteFromObjUseList ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDeleteFromObjUseList instance */ /* method is called to remove an item type */ /* from an object's in-use list. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PUSEITEM pUseItem; BOOL fSuccess; /* Success indicator */ fSuccess = _wpDeleteFromObjUseList(self, pUseItem); ΓòÉΓòÉΓòÉ <hidden> wpFindUseItem ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpFindUseItem instance method is */ /* called to retrieve an item type from */ /* the object's in-use list. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ultype; PUSEITEM pCurrentUseItem; /* A pointer to a USEITEM structure */ PUSEITEM ppUseItem; /* Success indicator */ ppUseItem = _wpFindUseItem(self, ultype, pCurrentUseItem); ΓòÉΓòÉΓòÉ <hidden> wpUnlockObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpUnlockObject instance method is */ /* called to allow an object to go into */ /* the dormant state. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; BOOL fSuccess; /* Success indicator */ fSuccess = _wpUnlockObject(self); ΓòÉΓòÉΓòÉ <hidden> wpClose ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpClose instance method is called */ /* to close all open views of an object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; BOOL fReturn; /* Success indicator */ fReturn = _wpClose(self); ΓòÉΓòÉΓòÉ <hidden> wpCopyObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCopyObject instance method is */ /* called to create a new copy of the */ /* object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; WPFolder * Folder; BOOL fLock; /* The lock object flag */ WPObject * Success; /* Success indicator */ Success = _wpCopyObject(self, Folder, fLock); ΓòÉΓòÉΓòÉ <hidden> wpCreateFromTemplate ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCreateFromTemplate instance */ /* method is called to create an object */ /* from a template. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; WPFolder * Folder; BOOL fLock; /* The lock object flag */ WPObject * Success; /* Success indicator */ Success = _wpCreateFromTemplate(self, Folder, fLock); ΓòÉΓòÉΓòÉ <hidden> wpCreateShadowObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCreateShadowObject instance */ /* method is called to create a shadow of */ /* an object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; WPFolder * Folder; BOOL fLock; /* Lock object flag */ WPObject * Success; /* Success indicator */ Success = _wpCreateShadowObject(self, Folder, fLock); ΓòÉΓòÉΓòÉ <hidden> wpDelete ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDelete instance method is called */ /* to delete an object and prompt for */ /* confirmation if necessary. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulConfirmations; ULONG ulsuccess; /* Success indicator */ ulsuccess = _wpDelete(self, ulConfirmations); ΓòÉΓòÉΓòÉ <hidden> wpDisplayHelp ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDisplayHelp instance method is */ /* called to allow the object to display a */ /* help panel. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulHelpPanelId; PSZ pszHelpLibrary; BOOL fSuccess; /* Success indicator */ fSuccess = _wpDisplayHelp(self, ulHelpPanelId, pszHelpLibrary); ΓòÉΓòÉΓòÉ <hidden> wpFilterPopupMenu ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpFilterPopupMenu instance method */ /* is called to allow the object to modify */ /* its context menu. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulFlags; HWND hwndcnr; BOOL fMultiSelect; ULONG ulRetcode; /* New pop-up menu flags for this object */ ulRetcode = _wpFilterPopupMenu(self, ulFlags, hwndcnr, fMultiSelect); ΓòÉΓòÉΓòÉ <hidden> wpHide ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpHide instance method is called to */ /* hide or minimize open views of this */ /* object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; BOOL fReturn; /* Success indicator */ fReturn = _wpHide(self); ΓòÉΓòÉΓòÉ <hidden> wpInsertPopupMenuItems ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpInsertPopupMenuItems instance */ /* method is called to allow an object to */ /* insert items into its popup menu. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndMenu; ULONG ulPostition; HMODULE hmod; ULONG ulMenuID; ULONG ulSubMenuId; BOOL fSuccess; /* Success indicator */ fSuccess = _wpInsertPopupMenuItems(self, hwndMenu, ulPostition, hmod, ulMenuID, ulSubMenuId); ΓòÉΓòÉΓòÉ <hidden> wpMenuItemHelpSelected ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpMenuItemHelpSelected instance */ /* method is called to allow the object to */ /* display the requested help panel. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulMenuId; BOOL fSuccess; /* Success indicator */ fSuccess = _wpMenuItemHelpSelected(self, ulMenuId); ΓòÉΓòÉΓòÉ <hidden> wpMenuItemSelected ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpMenuItemSelected instance method */ /* is called to allow an object to process */ /* a pop-up menu selection. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndFrame; ULONG ulMenuId; BOOL fSuccess; /* Success indicator */ fSuccess = _wpMenuItemSelected(self, hwndFrame, ulMenuId); ΓòÉΓòÉΓòÉ <hidden> wpModifyPopupMenu ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpModifyPopupMenu instance method */ /* is called to allow an object to add */ /* additional items to its pop-up menu. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndMenu; HWND hwndCnr; ULONG ulPosition; BOOL fSuccess; /* Success indicator */ fSuccess = _wpModifyPopupMenu(self, hwndMenu, hwndCnr, ulPosition); ΓòÉΓòÉΓòÉ <hidden> wpMoveObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpMoveObject instance method is */ /* called to move the object to a */ /* different location. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; WPFolder * Folder; BOOL fSuccess; /* Success indicator */ fSuccess = _wpMoveObject(self, Folder); ΓòÉΓòÉΓòÉ <hidden> wpOpen ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpOpen instance method is called to */ /* open a view to the object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndCnr; ULONG ulView; ULONG ulparam; /* Open view parameter */ HWND hwnd; /* Success indicator */ hwnd = _wpOpen(self, hwndCnr, ulView, ulparam); ΓòÉΓòÉΓòÉ <hidden> wpPrintObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpPrintObject instance method is */ /* called to print a view of the object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PPRINTDEST pPrintDest; /* The pointer to print data */ ULONG ulReserved; BOOL fSuccess; /* Success indicator */ fSuccess = _wpPrintObject(self, pPrintDest, ulReserved); ΓòÉΓòÉΓòÉ <hidden> wpRestore ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRestore instance method is called */ /* to allow the object to restore its */ /* views from the hidden or minimized */ /* states. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; BOOL fReturn; /* Success indicator */ fReturn = _wpRestore(self); ΓòÉΓòÉΓòÉ <hidden> wpQueryConfirmations ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryConfirmations instance */ /* method is called to determine which */ /* confirmations are set on this object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulflag; /* Confirmation flags */ ulflag = _wpQueryConfirmations(self); ΓòÉΓòÉΓòÉ <hidden> wpQueryDefaultHelp ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryDefaultHelp instance method */ /* is called to allow the object to */ /* specify its default help panel. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PULONG pHelpPanelId; PSZ pszHelpLibrary; BOOL fSuccess; /* Success indicator */ fSuccess = _wpQueryDefaultHelp(self, pHelpPanelId, pszHelpLibrary); ΓòÉΓòÉΓòÉ <hidden> wpQueryDefaultView ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryDefaultView instance method */ /* is called to allow the object to query */ /* its current default open view. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulView; ulView = _wpQueryDefaultView(self); ΓòÉΓòÉΓòÉ <hidden> wpQueryDetailsData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryDetailsData instance method */ /* is called to allow the object to query */ /* its current details data. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PVOID *ppDetailsData; PULONG pcp; BOOL fReturn; /* Success indicator */ fReturn = _wpQueryDetailsData(self, *ppDetailsData, pcp); ΓòÉΓòÉΓòÉ <hidden> wpQueryIcon ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryIcon instance method is */ /* called to allow the object to query its */ /* current icon. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HPOINTER hptrQryIcon; /* Success indicator */ hptrQryIcon = _wpQueryIcon(self); ΓòÉΓòÉΓòÉ <hidden> wpQueryIconData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryIconData instance method is */ /* called to allow the object to query the */ /* data to be used for its current icon. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PICONINFO ppIconInfo; BOOL fReturn; /* Success indicator */ fReturn = _wpQueryIconData(self, ppIconInfo); ΓòÉΓòÉΓòÉ <hidden> wpQueryStyle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryStyle instance method allows */ /* the object to query its current class */ /* style. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulnwQrySt; ulnwQrySt = _wpQueryStyle(self); ΓòÉΓòÉΓòÉ <hidden> wpQueryTitle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryTitle instance method is */ /* called to allow the object to query its */ /* current title. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszQTitle; /* A pointer to the object's title */ pszQTitle = _wpQueryTitle(self); ΓòÉΓòÉΓòÉ <hidden> wpSetDefaultHelp ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetDefaultHelp instance method is */ /* called to set the default help panel */ /* for the object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulPanelID; PSZ pszHelpLibrary; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSetDefaultHelp(self, ulPanelID, pszHelpLibrary); ΓòÉΓòÉΓòÉ <hidden> wpSetDefaultView ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetDefaultView instance method is */ /* called to allow an object to change its */ /* current default open view. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulView; BOOL fReturn; /* Success indicator */ fReturn = _wpSetDefaultView(self, ulView); ΓòÉΓòÉΓòÉ <hidden> wpSetIcon ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetIcon instance method is called */ /* to allow the object to set its current */ /* icon. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HPOINTER hptrNewIcon; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSetIcon(self, hptrNewIcon); ΓòÉΓòÉΓòÉ <hidden> wpSetIconData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetIconData instance method is */ /* called to allow the object to */ /* permanently set its current icon. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PICONINFO ppIconInfo; BOOL fReturn; /* Success indicator */ fReturn = _wpSetIconData(self, ppIconInfo); ΓòÉΓòÉΓòÉ <hidden> wpSetStyle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetStyle instance method is */ /* called to allow an object to set its */ /* current object style. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulNewStyle; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSetStyle(self, ulNewStyle); ΓòÉΓòÉΓòÉ <hidden> wpSetTitle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetTitle instance method is */ /* called to allow the object to set its */ /* current title. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszNewTitle; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSetTitle(self, pszNewTitle); ΓòÉΓòÉΓòÉ <hidden> wpQueryError ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryError instance method is */ /* called to retrieve the error identity */ /* of the last error condition. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulerrorid; /* Error identities */ ulerrorid = _wpQueryError(self); ΓòÉΓòÉΓòÉ <hidden> wpSetError ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetError instance method is */ /* called to identify an error condition. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulErrorID; BOOL fsuccess; /* Success indicator */ fsuccess = _wpSetError(self, ulErrorID); ΓòÉΓòÉΓòÉ <hidden> wpAllocMem ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAllocMem instance method is */ /* called to allocate memory for use by an */ /* object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG cbBytes; PULONG prc; /* Report error indicator */ PBYTE pbNewMem; /* Success indicator */ pbNewMem = _wpAllocMem(self, cbBytes, prc); ΓòÉΓòÉΓòÉ <hidden> wpFreeMem ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpFreeMem instance method is called */ /* to deallocate memory allocated by a */ /* call to the wpAllocMem method. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PBYTE pbMemory; BOOL fSuccess; /* Success indicator */ fSuccess = _wpFreeMem(self, pbMemory); ΓòÉΓòÉΓòÉ <hidden> wpFree ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpFree instance method is called to */ /* destroy the object and deallocate its */ /* associated resources. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; BOOL fReturn; /* Success indicator */ fReturn = _wpFree(self); ΓòÉΓòÉΓòÉ <hidden> wpInitData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpInitData instance method is */ /* called to allow the object to */ /* initialize its instance data. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; VOID void; void = _wpInitData(self); ΓòÉΓòÉΓòÉ <hidden> wpScanSetupString ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpScanSetupString instance method */ /* is called to allow an object to parse */ /* the setup string that is passed when */ /* the object is created. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszSetupString; PSZ pszKey; PSZ pszValue; PULONG pcbValue; BOOL fReturn; /* Success indicator */ fReturn = _wpScanSetupString(self, pszSetupString, pszKey, pszValue, pcbValue); ΓòÉΓòÉΓòÉ <hidden> wpSetup ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetup instance method is called */ /* to allow the newly created object to */ /* initialize itself. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszSetupString; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSetup(self, pszSetupString); ΓòÉΓòÉΓòÉ <hidden> wpUnInitData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpUnInitData instance method is */ /* called to allow the object to free */ /* allocated resources. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; VOID void; void = _wpUnInitData(self); ΓòÉΓòÉΓòÉ <hidden> wpDragOver ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDragOver instance method is */ /* called to inform the object that other */ /* objects are being dragged over it. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndCnr; PDRAGINFO pDragInfo; MRESULT mresRetcode; /* */ mresRetcode = _wpDragOver(self, hwndCnr, pDragInfo); ΓòÉΓòÉΓòÉ <hidden> wpDraggedOverObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDraggedOverObject instance method */ /* may be called on an object that is */ /* currently being dragged with the mouse */ /* to tell it what the current target */ /* object is. The return code from this */ /* method lets the system know whether the */ /* object being dragged can be dropped on */ /* the specified target. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * somSelf; WPObject * DraggedOverObject; MRESULT mresMRESULT; mresMRESULT = _wpDraggedOverObject(somSelf, DraggedOverObject); ΓòÉΓòÉΓòÉ <hidden> wpDrop ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDrop instance method is called to */ /* inform an object that another object */ /* has been dropped on it. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndCnr; PDRAGINFO pDragInfo; PDRAGITEM pDragItem; MRESULT mresRetcode; /* */ mresRetcode = _wpDrop(self, hwndCnr, pDragInfo, pDragItem); ΓòÉΓòÉΓòÉ <hidden> wpDroppedOnObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDroppedOnObject instance method */ /* is called on an object that has just */ /* been dragged (a source object) when the */ /* target object that it was dropped on */ /* does not know what action to perform. */ /* This instance method is only called on */ /* a source object when that source object */ /* has previously responded favorably to a */ /* wpDraggedOverObject instance method */ /* call. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * somSelf; WPObject * DroppedOnObject; BOOL fMRESULT; fMRESULT = _wpDroppedOnObject(somSelf, DroppedOnObject); ΓòÉΓòÉΓòÉ <hidden> wpEndConversation ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpEndConversation instance method */ /* is called to notify the object that the */ /* drag or drop operation is complete. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulItemId; ULONG ulResult; MRESULT mresreturn; mresreturn = _wpEndConversation(self, ulItemId, ulResult); ΓòÉΓòÉΓòÉ <hidden> wpFormatDragItem ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpFormatDragItem instance method is */ /* called to allow the object to format */ /* its drag information when the user */ /* starts to drag it. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PDRAGITEM pDragItem; BOOL fSuccess; /* Success indicator */ fSuccess = _wpFormatDragItem(self, pDragItem); ΓòÉΓòÉΓòÉ <hidden> wpRender ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRender instance method is called */ /* to request a drag or drop rendering */ /* format from the object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PDRAGTRANSFER ppdxfer; MRESULT mresreturn; mresreturn = _wpRender(self, ppdxfer); ΓòÉΓòÉΓòÉ <hidden> wpRenderComplete ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRenderComplete instance method is */ /* called to notify the object that the */ /* drag or drop rendering request is */ /* complete. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PDRAGTRANSFER ppdxfer; ULONG ulResult; MRESULT mresreturn; mresreturn = _wpRenderComplete(self, ppdxfer, ulResult); ΓòÉΓòÉΓòÉ <hidden> wpInsertObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCnrInsertObject instance method */ /* is called to insert a record into a */ /* container control window. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndCnr; PPOINTL pIcon; PMINIRECORDCORE pParent; PRECORDINSERT pRecInsert; /* Record position */ PMINIRECORDCORE pRetcode; /* Success indicator */ pRetcode = _wpCnrInsertObject(self, hwndCnr, pIcon, pParent, pRecInsert); ΓòÉΓòÉΓòÉ <hidden> wpRemoveObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCnrRemoveObject instance method */ /* is called to remove a record from a */ /* container control window. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndCnr; PMINIRECORDCORE pRecord; BOOL freturn; /* Success indicator */ freturn = _wpCnrRemoveObject(self, hwndCnr, pRecord); ΓòÉΓòÉΓòÉ <hidden> wpSetEmphasis ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCnrSetEmphasis instance method is */ /* called to allow the object to change */ /* its visual emphasis. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulEmphasisAttr; BOOL fTurnOn; BOOL fSuccess; /* Success indicator */ fSuccess = _wpCnrSetEmphasis(self, ulEmphasisAttr, fTurnOn); ΓòÉΓòÉΓòÉ <hidden> wpConfirmDelete ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpConfirmDelete instance method is */ /* called to allow the object to prompt */ /* the user to confirm the deletion of */ /* this object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG fConfirmations; /* The confirmation flags */ ULONG ulReturn; ulReturn = _wpConfirmDelete(self, fConfirmations); ΓòÉΓòÉΓòÉ <hidden> wpCopyFromTemplate ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpCopiedFromTemplate instance */ /* method is called to allow an object to */ /* perform class specific processing when */ /* a new object is created from a template.*/ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; VOID void; void = _wpCopiedFromTemplate(self); ΓòÉΓòÉΓòÉ <hidden> wpDoesObjectMatch ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpDoesObjectMatch instance method */ /* is called to allow the object to */ /* determine if it matches the specified */ /* criteria. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * object; PVOID pExtendedCriteria; BOOL fSuccess; /* Success indicator */ fSuccess = _wpDoesObjectMatch(object, pExtendedCriteria); ΓòÉΓòÉΓòÉ <hidden> wpRegisterView ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpRegisterView instance method is */ /* called to allow the object to register */ /* a new open view. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; HWND hwndFrame; PSZ pszViewTitle; BOOL fReturn; /* Success indicator */ fReturn = _wpRegisterView(self, hwndFrame, pszViewTitle); ΓòÉΓòÉΓòÉ <hidden> wpSwitchTo ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSwitchTo instance method is */ /* called to allow the object to give */ /* focus to the specified open view. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; ULONG ulView; BOOL fSuccess; /* Success indicator */ fSuccess = _wpSwitchTo(self, ulView); =============================================================================== ΓòÉΓòÉΓòÉ <hidden> wpclsCreateDefaultTemplates ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsCreateDefaultTemplates method */ /* is called to allow the specified class */ /* to create default template instances of */ /* its class. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; WPFolder * Folder; ULONG ulreturn; /* Number of templates created */ ulreturn = _wpclsCreateDefaultTemplates( self, Folder); ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectEnd ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsFindObjectEnd method is called */ /* to end the find operation started by a */ /* call to the wpclsFindObjectFirst method.*/ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; HFIND hfindfind; BOOL fSuccess; /* Success indicator */ fSuccess = _wpclsFindObjectEnd(self, hfindfind); ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectFirst ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsFindObjectFirst method is */ /* called to find workplace objects. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PHFIND pfind; PSZ pszTitle; WPFolder * Folder; BOOL fSubfolders; /* Scope indicator */ PVOID pExtendedCriteria; POBJECTS pBuf; PULONG pCount; BOOL fSuccess; /* Success indicator */ fSuccess = _wpclsFindObjectFirst(self, pfind, pszTitle, Folder, fSubfolders, pExtendedCriteria, pBuf, pCount); ΓòÉΓòÉΓòÉ <hidden> wpclsFindObjectNext ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsFindObjectNext method is */ /* called to find the next set of matching */ /* objects. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; HFIND hfindfind; POBJECTS pBuf; PULONG pCount; BOOL fSuccess; /* Success indicator */ fSuccess = _wpclsFindObjectNext(self, hfindfind, pBuf, pCount); ΓòÉΓòÉΓòÉ <hidden> wpclsInitData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsInitData method is called to */ /* allow the class object to initialize */ /* its instance data. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; VOID void; void = _wpclsInitData(self); ΓòÉΓòÉΓòÉ <hidden> wpclsMakeAwake ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsMakeAwake method is called to */ /* allow the specified class to awaken an */ /* object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PSZ pszTitle; ULONG ulStyle; HPOINTER hptrIcon; POBJDATA pObjData; WPFolder * Folder; ULONG ulUser; WPObject * Success; /* Success indicator */ Success = _wpclsMakeAwake(self, pszTitle, ulStyle, hptrIcon, pObjData, Folder, ulUser); ΓòÉΓòÉΓòÉ <hidden> wpclsNew ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsNew method is called to make */ /* an new instance of this class of object.*/ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PSZ pszTitle; PSZ pszSetupEnv; WPFolder * Folder; BOOL fLock; /* The lock object flag */ WPObject * Success; /* Success indicator */ Success = _wpclsNew(self, pszTitle, pszSetupEnv, Folder, fLock); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultHelp ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryDefaultHelp method is */ /* called to allow the class object to */ /* specify its default help panel for its */ /* instances. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PULONG pHelpPanelId; PSZ pszHelpLibrary; ULONG ulSuccess; /* Success indicator */ ulSuccess = _wpclsQueryDefaultHelp(self, pHelpPanelId, pszHelpLibrary); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDefaultView ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryDefaultView method is */ /* called to allow the class object to */ /* specify the default open view for its */ /* instance. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; ULONG ulView; /* Default open view */ ulView = _wpclsQueryDefaultView(self); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetails ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryDetails method is called */ /* to allow the class object to specify */ /* the default details view items for its */ /* instances. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PCLASSDETAILS pReturn; /* Success indicator */ pReturn = _wpclsQueryDetails(self); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryDetailsInfo ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryDetailsInfo method is */ /* called to allow the class object to */ /* specify its details to be used for its */ /* instances. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PCLASSFIELDINFO pClassFieldInfo; PULONG pSize; ULONG ulReturn; ulReturn = _wpclsQueryDetailsInfo(self, pClassFieldInfo, pSize); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryError ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryError class method */ /* queries the current error code held */ /* within a class object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * somSelf; ULONG ulErrorId; ulErrorId = _wpclsQueryError(somSelf); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryFolder ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryFolder method is called */ /* to get a pointer to a folder object */ /* that corresponds to a given file system */ /* location. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PSZ pszLocation; /* Folder location */ BOOL fLock; /* The lock object flag */ WPFolder * Success; /* Success indicator */ Success = _wpclsQueryFolder(self, pszLocation, fLock); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIcon ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryIcon method is called to */ /* allow the class object to specify the */ /* default icon to be used for its */ /* instances. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; HPOINTER hptrSuccess; /* Success indicator */ hptrSuccess = _wpclsQueryIcon(self); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryIconData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryIconData class method */ /* allows the system to build the class */ /* default icon for a given class. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * somSelf; PICONINFO pIconInfo; ULONG ulcbIconInfo; ulcbIconInfo = _wpclsQueryIconData(somSelf, pIconInfo); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryObject ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryObject class method */ /* returns the object pointer for a given */ /* persistent object handle. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * somSelf; HOBJECT hObject; WPObject * object; object = _wpclsQueryObject(somSelf, hObject); ΓòÉΓòÉΓòÉ <hidden> wpclsSetError ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsSetError class method sets the */ /* current error code within a class */ /* object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * somSelf; ULONG ulErrorId; BOOL fMRESULT; fMRESULT = _wpclsSetError(somSelf, ulErrorId); ΓòÉΓòÉΓòÉ <hidden> wpclsQuerySettingsPageSize ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQuerySettingsPageSize class */ /* method returns the default size of a */ /* settings page in dialog units for */ /* instances of this object class. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * somSelf; PSIZEL pSizl; BOOL fSuccess; fSuccess = _wpclsQuerySettingsPageSize( somSelf, pSizl); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryStyle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryStyle method is called to */ /* allow the class object to specify the */ /* default object class style for its */ /* instances. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; ULONG ulReturn; /* Class style for this object */ ulReturn = _wpclsQueryStyle(self); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryTitle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryTitle method is called to */ /* allow the class object to specify the */ /* default title for its instances. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; PSZ pszTitle; pszTitle = _wpclsQueryTitle(self); ΓòÉΓòÉΓòÉ <hidden> wpclsUnInitData ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsUnInitData method is called to */ /* allow the class object to free */ /* allocated resources. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPObject * self; VOID void; void = _wpclsUnInitData(self); ΓòÉΓòÉΓòÉ <hidden> wpAddFileMenuPage ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddFileMenuPage instance method */ /* is called to allow the object to add */ /* the Menu page to its settings */ /* notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; HWND hwndNotebook; ULONG ulRetCode; /* Page identifier */ ulRetCode = _wpAddFileMenuPage(self, hwndNotebook); ΓòÉΓòÉΓòÉ <hidden> wpAddFile1Page ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddFile1Page instance method is */ /* called to allow the object to add the */ /* File 1 page to its settings notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; HWND hwndNotebook; ULONG ulRetCode; /* Page identifier */ ulRetCode = _wpAddFile1Page(self, hwndNotebook); ΓòÉΓòÉΓòÉ <hidden> wpAddFile2Page ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddFile2Page instance method is */ /* called to allow the object to add the */ /* File 2 page to its settings notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; HWND hwndNotebook; ULONG ulRetCode; /* Page identifier */ ulRetCode = _wpAddFile2Page(self, hwndNotebook); ΓòÉΓòÉΓòÉ <hidden> wpAddFile3Page ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpAddFile3Page instance method is */ /* called to allow the object to add the */ /* File 3 page to its settings notebook. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; HWND hwndNotebook; ULONG ulRetCode; /* Page identifier */ ulRetCode = _wpAddFile3Page(self, hwndNotebook); ΓòÉΓòÉΓòÉ <hidden> wpQueryHandle ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryHandle instance method */ /* returns a persistent object handle for */ /* the given object instance. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * somSelf; HOBJECT hObject; hObject = _wpQueryHandle(somSelf); ΓòÉΓòÉΓòÉ <hidden> wpQueryRealName ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryRealName instance method is */ /* called to allow the object to query its */ /* physical file name. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; PSZ pszFilename; PULONG pcb; BOOL fQualified; /* Success indicator */ BOOL fSuccess; /* Success indicator */ fSuccess = _wpQueryRealName(self, pszFilename, pcb, fQualified); ΓòÉΓòÉΓòÉ <hidden> wpQueryType ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpQueryType instance method is */ /* called to allow the object to query the */ /* type of its file. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; PSZ psztype; psztype = _wpQueryType(self); ΓòÉΓòÉΓòÉ <hidden> wpSetRealName ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetRealName instance method will */ /* set the physical name of a file system */ /* object. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPObject * self; PSZ pszFilename; BOOL fsuccess; /* Success indicator */ fsuccess = _wpSetRealName(self, pszFilename); ΓòÉΓòÉΓòÉ <hidden> wpSetType ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpSetType instance method is called */ /* to allow the object to change the type */ /* of its file. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> WPFileSystem * self; PSZ pszTypes; BOOL fReturn; /* Success indicator */ fReturn = _wpSetType(self, pszTypes); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceFilter ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryInstanceFilter method is */ /* called to allow the class object to */ /* specify the file title filters for */ /* instances of its class. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPFileSystem * self; PSZ pszsuccess; /* Success indicator */ pszsuccess = _wpclsQueryInstanceFilter(self); ΓòÉΓòÉΓòÉ <hidden> wpclsQueryInstanceType ΓòÉΓòÉΓòÉ /*******************************************/ /* The wpclsQueryInstanceType method is */ /* called to allow the class object to */ /* specify the file types for instances */ /* of its class. */ /*******************************************/ #define INCL_WINWORKPLACE #include <os2.h> M_WPFileSystem * self; PSZ pszsuccess; /* Success indicator */ pszsuccess = _wpclsQueryInstanceType(self);