Jump to content

WPObject: Difference between revisions

From EDM2
Ak120 (talk | contribs)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Description==
This is the root Workplace object class. This is the most fundamental class, from which all other Workplace objects are derived. This class contains functionality common to all classes.  
This is the most fundamental WPS class, from which all other WPS classes are derived. This class contains functionality common to all classes.  


'''Note:''' This class is only an abstract superclass for subclasses. There should not be any objects of this class directly, but only of the subclasses.
'''Note:''' This class is only an abstract superclass for subclasses. There should not be any objects of this class directly, but only of the subclasses.


The immediate descendant classes of WPObject are WPAbstract, WPFileSystem, WPTransient and are called ''storage classes''. This descendant classes stores the object information in a persistent form.  
The immediate descendant classes of WPObject are [[WPAbstract]], [[WPFileSystem]], [[WPTransient]] and are called ''storage classes''. This descendant classes stores the object information in a persistent form.  


==Class definition file==
; Default Tittle: "Object"
* wpobject.idl  
; DLL: [[PMWP.DLL]]
; Class definition file: wpobject.idl


==DLL==
==Class hierarchy==
* PMWP.DLL
* [[SOMObject]]
 
** WPObject
==Class hierarchy SOMObject==
* '''SOMObject'''


==Instance methods==
==Instance methods==
Settings Notebook methods
Settings Notebook methods
 
*wpAddObjectGeneralPage
* [[wpAddObjectGeneralPage]]
*wpAddObjectGeneralPage2
* [[wpAddObjectGeneralPage2]]
*wpAddObjectWindowPage
* [[wpAddObjectWindowPage]]
*wpAddSettingsPages
* [[wpAddSettingsPages]]
*wpInsertSettingsPage
* [[wpInsertSettingsPage]]


Save/Restore State methods
Save/Restore State methods
 
*wpRestoreData
* [[wpRestoreData]]
*wpRestoreLong
* [[wpRestoreLong]]
*wpRestoreState
* [[wpRestoreState]]
*wpRestoreString
* [[wpRestoreString]]
*[[wpSaveData]]
* [[wpSaveData]]
*wpSaveDeferred
* [[wpSaveDeferred]]
*wpSaveImmediate
* [[wpSaveImmediate]]
*wpSaveLong
* [[wpSaveLong]]
*wpSaveState
* [[wpSaveState]]
*wpSaveString
* [[wpSaveString]]


Object Usage methods
Object Usage methods
 
*wpAddToObjUseList
* [[wpAddToObjUseList]]
*wpAssertObjectMutexSem
* [[wpAssertObjectMutexSem]]
*wpCnrDeleteUseItem
* [[wpCnrDeleteUseItem]]
*wpDeleteFromObjUseList
* [[wpDeleteFromObjUseList]]
*wpFindUseItem
* [[wpFindUseItem]]
*wpIsLocked
* [[wpIsLocked]]
*wpLockObject
* [[wpLockObject]]
*wpReleaseObjectMutexSem
* [[wpReleaseObjectMutexSem]]
*wpRequestObjectMutexSem
* [[wpRequestObjectMutexSem]]
*wpUnlockObject  
* [[wpUnlockObject]]


Pop-Up Menu methods
Pop-Up Menu methods
 
*wpAppendObject
* [[wpAppendObject]]
*wpClose
* [[wpClose]]
*wpCopyObject
* [[wpCopyObject]]
*wpCreateAnother
* [[wpCreateAnother]]
*wpCreateFromTemplate
* [[wpCreateFromTemplate]]
*wpCreateShadowObject
* [[wpCreateShadowObject]]
*wpCreateShadowObjectExt
* [[wpCreateShadowObjectExt]]
*wpDelete
* [[wpDelete]]
*wpDisplayHelp
* [[wpDisplayHelp]]
*wpDisplayMenu
* [[wpDisplayMenu]]
*wpFilterMenu
* [[wpFilterMenu]]
*wpFilterPopupMenu
* [[wpFilterPopupMenu]]
*wpHide
* [[wpHide]]
*wpInsertMenuItems
* [[wpInsertMenuItems]]
*wpInsertPopupMenuItems
* [[wpInsertPopupMenuItems]]
*wpIsObjectInitialized
* [[wpIsObjectInitialized]]
*wpMenuItemHelpSelected
* [[wpMenuItemHelpSelected]]
*wpMenuItemSelected
* [[wpMenuItemSelected]]
*wpModifyMenu
* [[wpModifyMenu]]
*wpModifyPopupMenu
* [[wpModifyPopupMenu]]
*wpMoveObject
* [[wpMoveObject]]
*wpObjectReady
* [[wpObjectReady]]
*wpOpen
* [[wpOpen]]
*wpPrintObject
* [[wpPrintObject]]
*wpQueryMenuStyle
* [[wpQueryMenuStyle]]
*wpReplaceObject
* [[wpReplaceObject]]
*wpRestore
* [[wpRestore]]
*wpSetMenuStyle
* [[wpSetMenuStyle]]


Query and Set Object Information methods
Query and Set Object Information methods
 
* wpFindTaskRec
                    wpFindTaskRec
* wpIdentify
                        wpIdentify
* wpModifyStyle
                        wpModifyStyle
* wpQueryButtonAppearance
                        wpQueryButtonAppearance
* wpQueryConcurrentView
                        wpQueryConcurrentView
* wpQueryConfirmations
                        wpQueryConfirmations
* wpQueryContainerFlagPtr
                        wpQueryContainerFlagPtr
* wpQueryCoreRecord
                        wpQueryCoreRecord
* wpQueryDefaultHelp
                        wpQueryDefaultHelp
* wpQueryDefaultIconPos
                        wpQueryDefaultIconPos
* wpQueryDefaultView
                        wpQueryDefaultView
* wpQueryDetailsData
                        wpQueryDetailsData
* wpQueryFolder
                        wpQueryFolder
* wpQueryHandle
                        wpQueryHandle
* wpQueryIcon
                        wpQueryIcon
* wpQueryIconData
                        wpQueryIconData
* wpQueryMinWindow
                        wpQueryMinWindow
* wpQueryNameClashOptions
                        wpQueryNameClashOptions
* wpQueryObjectID
                        wpQueryObjectID
* wpQueryScreenGroupID (Intel)
                        wpQueryScreenGroupID (Intel)
* wpQueryStyle
                        wpQueryStyle
* wpQueryTrueStyle
                        wpQueryTrueStyle
* wpQueryTitle
                        wpQueryTitle
* wpSetButtonAppearance
                        wpSetButtonAppearance
* wpSetConcurrentView
                        wpSetConcurrentView
* wpSetDefaultHelp
                        wpSetDefaultHelp
* wpSetDefaultIconPos
                        wpSetDefaultIconPos
* wpSetDefaultView
                        wpSetDefaultView
* wpSetFolder
                        wpSetFolder
* wpSetIcon
                        wpSetIcon
* wpSetIconData
                        wpSetIconData
* wpSetMinWindow
                        wpSetMinWindow
* wpSetObjectID
                        wpSetObjectID
* wpSetStyle
                        wpSetStyle
* wpSetTaskRec
                        wpSetTaskRec
* wpSetTitle
                        wpSetTitle
* wpViewObject  
                        wpViewObject  


Error Handling methods
Error Handling methods
Line 155: Line 147:


Setup/Cleanup methods
Setup/Cleanup methods
 
*wpFree
* wpFree
*wpInitData
* wpInitData
*wpScanSetupString
* wpScanSetupString
*wpSetup
* wpSetup
*wpSetupOnce
* wpSetupOnce
*wpUnInitData
* wpUnInitData


==wpSetup override by WPObject==
==wpSetup override by WPObject==
Line 171: Line 162:
* [[somUninit]]
* [[somUninit]]


==Class methods==
*wpclsCreateDefaultTemplates
*wpclsDecUsage
*wpclsFindObjectEnd
*wpclsFindObjectFirst
*wpclsFindObjectNext
*wpclsFindOneObject
*wpclsIncUsage
*wpclsInitData
*wpclsInsertMultipleObjects
*wpclsMakeAwake
*wpclsNew
*wpclsObjectFromHandle
*wpclsQueryButtonAppearance
*wpclsQueryDefaultHelp
*wpclsQueryDefaultView
*wpclsQueryDetails
*wpclsQueryDetailsInfo
*wpclsQueryError
*wpclsQueryExtendedCriteria
*wpclsQueryFolder
*wpclsQueryIcon
*wpclsQueryIconData
*wpclsQueryObject
*wpclsQuerySearchInfo
*wpclsQuerySettingsPageSize
*wpclsQueryStyle
*wpclsQueryTitle
*wpclsRemoveObjects
*wpclsSetError
*wpclsSetIconData
*wpclsSetIcon
*wpclsSetSettingsPageSize
*wpclsUnInitData


==SOMClass methods==
==SOMClass methods==
Overridden methods:
Overridden methods:
* [[somClassReady]]
* [[somClassReady]]
* [[somNew ]]
* [[somNew]]
* [[somRenew]]
* [[somRenew]]


==Alternatives==
* XWorkplace created an derivative version called [[XFldObject]].


[[Category:The OS/2 API Project]]
[[Category:WPS Classes]]

Latest revision as of 01:12, 22 July 2020

This is the root Workplace object class. This is the most fundamental class, from which all other Workplace objects are derived. This class contains functionality common to all classes.

Note: This class is only an abstract superclass for subclasses. There should not be any objects of this class directly, but only of the subclasses.

The immediate descendant classes of WPObject are WPAbstract, WPFileSystem, WPTransient and are called storage classes. This descendant classes stores the object information in a persistent form.

Default Tittle
"Object"
DLL
PMWP.DLL
Class definition file
wpobject.idl

Class hierarchy

Instance methods

Settings Notebook methods

  • wpAddObjectGeneralPage
  • wpAddObjectGeneralPage2
  • wpAddObjectWindowPage
  • wpAddSettingsPages
  • wpInsertSettingsPage

Save/Restore State methods

  • wpRestoreData
  • wpRestoreLong
  • wpRestoreState
  • wpRestoreString
  • wpSaveData
  • wpSaveDeferred
  • wpSaveImmediate
  • wpSaveLong
  • wpSaveState
  • wpSaveString

Object Usage methods

  • wpAddToObjUseList
  • wpAssertObjectMutexSem
  • wpCnrDeleteUseItem
  • wpDeleteFromObjUseList
  • wpFindUseItem
  • wpIsLocked
  • wpLockObject
  • wpReleaseObjectMutexSem
  • wpRequestObjectMutexSem
  • wpUnlockObject

Pop-Up Menu methods

  • wpAppendObject
  • wpClose
  • wpCopyObject
  • wpCreateAnother
  • wpCreateFromTemplate
  • wpCreateShadowObject
  • wpCreateShadowObjectExt
  • wpDelete
  • wpDisplayHelp
  • wpDisplayMenu
  • wpFilterMenu
  • wpFilterPopupMenu
  • wpHide
  • wpInsertMenuItems
  • wpInsertPopupMenuItems
  • wpIsObjectInitialized
  • wpMenuItemHelpSelected
  • wpMenuItemSelected
  • wpModifyMenu
  • wpModifyPopupMenu
  • wpMoveObject
  • wpObjectReady
  • wpOpen
  • wpPrintObject
  • wpQueryMenuStyle
  • wpReplaceObject
  • wpRestore
  • wpSetMenuStyle

Query and Set Object Information methods

  • wpFindTaskRec
  • wpIdentify
  • wpModifyStyle
  • wpQueryButtonAppearance
  • wpQueryConcurrentView
  • wpQueryConfirmations
  • wpQueryContainerFlagPtr
  • wpQueryCoreRecord
  • wpQueryDefaultHelp
  • wpQueryDefaultIconPos
  • wpQueryDefaultView
  • wpQueryDetailsData
  • wpQueryFolder
  • wpQueryHandle
  • wpQueryIcon
  • wpQueryIconData
  • wpQueryMinWindow
  • wpQueryNameClashOptions
  • wpQueryObjectID
  • wpQueryScreenGroupID (Intel)
  • wpQueryStyle
  • wpQueryTrueStyle
  • wpQueryTitle
  • wpSetButtonAppearance
  • wpSetConcurrentView
  • wpSetDefaultHelp
  • wpSetDefaultIconPos
  • wpSetDefaultView
  • wpSetFolder
  • wpSetIcon
  • wpSetIconData
  • wpSetMinWindow
  • wpSetObjectID
  • wpSetStyle
  • wpSetTaskRec
  • wpSetTitle
  • wpViewObject

Error Handling methods

  • wpQueryError
  • wpSetError

Memory Management methods

  • wpAllocMem
  • wpFreeMem

Direct Manipulation methods

  • wpDraggedOverObject
  • wpDragOver
  • wpDrop
  • wpDroppedOnObject
  • wpEndConversation
  • wpFormatDragItem
  • wpRender
  • wpRenderComplete

Miscellaneous methods

  • wpCnrRefreshDetails
  • wpCnrRemoveObject
  • wpCnrSetEmphasis
  • wpConfirmDelete
  • wpConfirmObjectTitle
  • wpCopiedFromTemplate
  • wpDoesObjectMatch
  • wpFindViewItem
  • wpIsDeleteable
  • wpRegisterView
  • wpSwitchTo
  • wpWaitForClose

Setup/Cleanup methods

  • wpFree
  • wpInitData
  • wpScanSetupString
  • wpSetup
  • wpSetupOnce
  • wpUnInitData

wpSetup override by WPObject

SOMObject instance methods

Class methods

  • wpclsCreateDefaultTemplates
  • wpclsDecUsage
  • wpclsFindObjectEnd
  • wpclsFindObjectFirst
  • wpclsFindObjectNext
  • wpclsFindOneObject
  • wpclsIncUsage
  • wpclsInitData
  • wpclsInsertMultipleObjects
  • wpclsMakeAwake
  • wpclsNew
  • wpclsObjectFromHandle
  • wpclsQueryButtonAppearance
  • wpclsQueryDefaultHelp
  • wpclsQueryDefaultView
  • wpclsQueryDetails
  • wpclsQueryDetailsInfo
  • wpclsQueryError
  • wpclsQueryExtendedCriteria
  • wpclsQueryFolder
  • wpclsQueryIcon
  • wpclsQueryIconData
  • wpclsQueryObject
  • wpclsQuerySearchInfo
  • wpclsQuerySettingsPageSize
  • wpclsQueryStyle
  • wpclsQueryTitle
  • wpclsRemoveObjects
  • wpclsSetError
  • wpclsSetIconData
  • wpclsSetIcon
  • wpclsSetSettingsPageSize
  • wpclsUnInitData

SOMClass methods

Overridden methods:

Alternatives

  • XWorkplace created an derivative version called XFldObject.