View source for WPSProgRef - What's New

{{WPSProgRef}}
{{IBM-Reprint}}

Following are the new classes and methods for OS/2 Warp Version 4.
==New Classes==
The following classes are new for OS/2 Warp Version 4. These include the Internet and Plug and Play classes. There is also a new WPImageFile class that is a parent to WPBitmap.

The new WPClassManager is responsible for modifying the SOM class manager to support object class replacement.

The following are the Workplace Shell Plug and Play classes.
* [[WPDevAudio]]
* [[WPDevBus]]
* [[WPDevCDRom]]
* [[WPDevCPU]]
* [[WPDevice]]
* [[WPDevDiskette]]
* [[WPDevDisplay]]
* [[WPDevHarddrive]]
* [[WPDevKeyboard]]
* [[WPDevMemory]]
* [[WPDevMouse]]
* [[WPDevParallel]]
* [[WPDevPeriph]]
* [[WPDevSerial]]
* [[WPDevTape]]
* [[WPDevTimer]]
* [[WPHwManager]]

The following classes are Workplace Shell Internet classes.
* [[WPHost]]
* [[WPHtml]]
* [[WPUrl]]
* [[WPUrlFolder]]

The following are other new Workplace Shell classes.
* [[WPClassManager]]
* [[WPImageFile]]
==New Methods==
The following Workplace Shell methods are new for OS/2 Warp Version 4.

There are no methods for the Internet classes.

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpGetTrueClassName
| Returns the class name for the given object.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAddBecomePage
| Adds the standard type page to the object's Settings notebook. This method should always be overridden in order to replace or remove the Become page from the object's Settings notebook. To remove the page from the Settings notebook, the override method should return SETTINGS_PAGE_REMOVED without calling the parent method. To replace the page with another page, the override method should call the wpInsertSettingsPage method without calling the parent method.
|-
| wpQueryHandleFromContents
| Returns a handle to a known system data type based on a file's contents. This is an abstract method; subclasses that describe files for which a system handle type exist (such as WPIcon or WPBitmap) should subclass this method.
|-
| wpQueryPointerFromContents
| Returns a pointer to shared memory containing the contents of the WPDataFile object.
|-
| wpRenderFromClipboard
| Opens the clipboard and retrieves the type of data specified in the clipboard format passed in, then writes the clipboard data to a file.
|-
| wpSetContentsFromHandle
| Sets a file's contents based on a handle to a known system data type. This is an abstract method; subclasses that describe files for which a system handle type exist (such as WPIcon or WPBitmap) should subclass this method.
|-
| wpSetContentsFromPointer
| Sets a WPDataFile object's contents based on a pointer to shared memory.
|-
| wpclsAddClipboardAssoc
| Adds an association between a clipboard format and a particular class name.
|-
| wpclsEnumClipboardClasses
| Enumerates through all the object classes that a particular rendering mechanism supports.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpQueryAutoLockup
| Returns the current value of the automatic lockup option.
|-
| wpQueryDefaultDropOp
| Queries the default drop operation of objects that are dropped on the Desktop. The default is set on the Desktop page of the Desktop's Settings notebook. This method can be overridden to control the Desktop's default drop operation
|-
| wpQueryLockupAutoDim
| Returns the current value of the lockup auto-dim option.
|-
| wpQueryLockupBackground
| Returns the current values for the lockup background.
|-
| wpQueryLockupFullScreen
| Returns the current value of the lockup full-screen option.
|-
| wpQueryLockupOnStartup
| Returns the current value of the lockup on the startup option.
|-
| wpQueryLockupTimeout
| Returns the current timeout value for automatic lockup.
|-
| wpSetAutoLockup
| Sets the value of the automatic lockup option.
|-
| wpSetDefaultDropOp
| Sets the default drop operation of objects that are dropped on the Desktop. The default is set on the Desktop page of the Desktop's Settings notebook.
|-
| wpSetLockupAutoDim
| Sets the value of the lockup auto-dim option.
|-
| wpSetLockupBackground
| Sets the current values for the lockup background.
|-
| wpSetLockupFullScreen
| Sets the value of the lockup full-screen option.
|-
| wpSetLockupOnStartup
| Sets the value of the lockup on the startup option.
|-
| wpSetLockupTimeout
| Sets the timeout value for automatic lockup.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAddSnoop1Page
| Adds the Detection Level page to the settings notebook.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAddDeviceDevice1Page
| Adds the first Device page to the settings notebook.
|-
| wpAddDeviceDevice2Page
| Adds the second Device page to the settings notebook.
|-
| wpAddDeviceDMA1Page
| Adds the DMA Channel page to the settings notebook.
|-
| wpAddDeviceIO1Page
| Adds the I/O Ports page to the settings notebook.
|-
| wpAddDeviceIRQ1Page
| Adds the IRQ Level page to the settings notebook.
|-
| wpAddDeviceMemory1Page
| Adds the Memory page to the settings notebook.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAddReserveDriveLetterPage
| Adds the reserve drive letter page to the Settings notebook. This method should always be overridden in order to replace or remove the Reserve Drive Letter page from the object's Settings notebook. To remove the page from the Settings notebook, the override method should return SETTINGS_PAGE_REMOVED without calling the parent method. To replace the page with another page, the override method should call the wpInsertSettingsPage method without calling the parent method.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAddUserItemsToPopupMenu
| Adds user-defined items to the popup menu.
|-
| wpQueryEASupport
| Determines whether extended attributes are supported for the specified file system object.
|-
| wpQueryRefreshFlags
| Queries the refresh flags for a file system object. The refresh flags consist of a DIRTYBIT and a FOUNDBIT that are used to allow refresh to detect deleted files and new files after asking a folder to re-populate.
|-
| wpSetRefreshFlags
| Sets the refresh flags for a file system object. The refresh flags consist of a DIRTYBIT and a FOUNDBIT that are used to allow refresh to detect deleted files and new files, after asking a folder to re-populate.
|-
| wpclsQueryInstanceClass
| Returns the name of a class that this object can become.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAddFolderMenu2Page
| Adds the standard Menu2 page to the Settings notebook. This method should always be overridden in order to replace or remove the Menu page 2 from the object's Settings notebook. To remove the page from the Settings notebook, the override method should return SETTINGS_PAGE_REMOVED without calling the parent method. To replace the page with another page, the override method should call the wpInsertSettingsPage method without calling the parent method.
|-
| wpFlushNotifications
| Forces all pending file system notifications for a folder to be processed immediately.
|-
| wpFreeIconPosData
| Frees the .ICONPOS extended attribute (EA) information that is allocated by wpInitIconPosData.
|-
| wpIdentify
| Returns a string that is unique within a given container that identifies the specified object.
|-
| wpInitIconPosData
| Reads the .ICONPOS extended attribute (EA) for the folder directory to determine where to position the object icons within the folder.
|-
| wpQueryFldrBackground
| Returns the current values for the folder background.
|-
| wpQueryIconPosition
| Finds the saved icon postion for this record.
|-
| wpQueryIconTextBackgroundColor
| Returns the current color being used for the icon text background.
|-
| wpQueryIconTextColor
| Returns the current color being used for the icon text in the specified view.
|-
| wpQueryIconTextVisibility
| Returns the current state of icon text visibility for the specified view.
|-
| wpQueryMenuBarVisibility
| Returns the visibility state of the folder's menu bar.
|-
| wpQueryOpenFolders
| Allows for the enumeration of all open folders in the system.
|-
| wpQueryShadowTextColor
| Returns the current color being used for the shadow text in the specified view.
|-
| wpRestoreFldrRunObjs
| For open work area folders, goes through the list of objects last saved by wpStoreFldrRunObjs and reopens all views of those objects that were open when the work area folder was last closed.
|-
| wpSetFldrBackground
| Sets the values for the folder background.
|-
| wpSetIconTextBackgroundColor
| Sets the color to be used for the icon text background.
|-
| wpSetIconTextColor
| Sets the color to be used for the icon text for the specified view.
|-
| wpSetIconTextVisibility
| Sets the icon text visibility for the specified view.
|-
| wpSetMenuBarVisibility
| Sets the visibility state of the folder's menu bar.
|-
| wpSetShadowTextColor
| Sets the color to be used for the shadow text for the specified view.
|-
| wpStoreFldrRunObjs
| Called when a work area folder is closed. Saves a list of the objects within the work area folder that are open when the work area folder is closed, then closes all open views of these objects.
|-
| wpStoreIconPosData
| Stores the ICONPOS data passed to this method on the folder object's .ICONPOS extended attribute (EA).
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpQueryBitmapData
| Returns a pointer to the bitmap data for the image file.
|-
| wpQueryBitmapHandle
| Returns a handle to the bitmap that can be displayed showing the contents of the image file and a handle to the palette to be used when displaying the bitmap.
|-
| wpQueryBitmapInfoHeader
| Returns a pointer to the bitmap information header for the image file.
|-
| wpReadImageFile
| Reads the image data for the image file and stores it in the instance data for the object. If the image data has already been read, this method simply returns TRUE. It does not refresh the image data.
|-
| wpSetBitmapData
| Sets the bitmap data for the image file. This method will convert the bitmap data to the appropriate format and update the actual image data file.
|-
| wpWriteImageFile
| Writes the image data for the image file from the instance data.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpMoveJobObject
| Moves a print job to a different printer.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpAppendObject
| Appends a file system object to another file system object.
|-
| wpAssertObjectMutexSem
| This instance method verifies that an object's mutex semaphore is held for the current thread.
|-
| wpFilterMenu
| Filters out options from the object's pop-up menu that do not apply. (OS/2 Version 4 or higher.)
|-
| wpFindTaskRec
| An object is sent this message to return information specific to the task being performed in a task thread.
|-
| wpInsertMenuItems
| Inserts items into the object's pop-up menu. (OS/2 Version 4 or higher.)
|-
| wpModifyMenu
| Adds new options to the object's pop-up menu. (OS/2 Version 4 or higher.)
|-
| wpQueryMenuStyle
| Returns the current menu style, which is either long or short.
|-
| wpQueryTrueStyle
| Queries this object's current class true style.
|-
| wpReleaseObjectMutexSem
| Releases the mutex semaphore for an object. Each object has associated with it a mutex semaphore that can be used to serialize access to resources.
|-
| wpReplaceObject
| Replaces an object in another folder.
|-
| wpRequestObjectMutexSem
| Requests the mutex semaphore for an object. Each object has associated with it a mutex semaphore that can be used to serialize access to resources.
|-
| wpSetFolder
| Sets this object to reside in the specified folder.
|-
| wpSetMenuStyle
| Sets the menu style to be either long or short.
|-
| wpSetTaskRec
| Adds, replaces, or deletes a task data block.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpFreeCellData
| Frees the data for the specified cell in a palette object.
|}

{| class="wikitable"
|+
! Method Name
! Description
|-
| wpSetJobProperties
|}
==New Presentation Manager Functions ==
{| class="wikitable"
|+
! Method Name
! Description
|-
| [[WinNotebookButtonFromID]]
| This function exports a convience function to find BS_NOTEBOOKBUTTON buttons. WinNotebookButtonFromID, given the HWND of the dialog of the properties page and the ID of the button along with the button of the properties page (for example, Undo, Default, or Help), returns the HWND for that button. This is used with the buttons of the BS_NOTEBOOKBUTTON style. Ownership of buttons of this style is changed from the dialog to the notebook after the dialog is loaded.
|-
| [[WinWaitForShell]]
| This function allows applications to wait for the Shell to be available. WinWaitForShell is used by an application when it needs to wait for the Workplace Shell to be available in order for the application to continue. For example, the application might be started in STARTUP.CMD, and yet it wants to create objects on the Workplace Shell. The application can use WinWaitForShell to wait for the Workplace Shell to be ready to start receiving the create requests. By using the optional query bit, it can check on those conditions without waiting on them.
|}