Class definition file: wpobject.idl
Class hierarchy SOMObject
WPObject
Description
This is the root Workplace object class. This is the fundamental class from which all Workplace objects are derived, regardless of where they are actually stored. Immediate descendant classes of WPObject are called storage classes, because they take responsibility for storing the object information, typically in a persistent form. Predefined Workplace object storage classes are the following:
A Workplace object of this class cannot be created.
Menu ID list
The following list shows the WPMENUID menu IDs for this class:
Menu item text
Instance methods
The following lists show how all the WPObject instance methods are related within functional areas:
Settings Notebook methods
Save/Restore State methods
Object Usage methods
Pop-Up Menu methods
Query and Set Object Information methods
Error Handling methods
Memory Management methods
Direct Manipulation methods
Miscellaneous methods
Setup/Cleanup methods
wpSetup override by WPObject
The following table shows the keyname-value pairs added by the WPObject class.
┌──────────────────┬────────────────────┬───────────────────────────┐│KEYNAME │VALUE │DESCRIPTION │ ├──────────────────┼────────────────────┼───────────────────────────┤ │CCVIEW │DEFAULT │The default value of the │ │ │ │concurrent view setting of │ │ │ │the system is used when the│ │ │ │user selects open. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │YES │This sets the object's │ │ │ │multiple concurrent view │ │ │ │behavior, so that new views│ │ │ │of this object are created │ │ │ │every time the user selects│ │ │ │open. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │Opened view of this object │ │ │ │resurfaces when the user │ │ │ │selects open. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │DEFAULTVIEW │SETTINGS │This sets the default open │ │ │ │view to Settings view. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │id │This sets the default open │ │ │ │view to the id of a │ │ │ │user-added view (0-9). │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │DEFAULT │This sets the default open │ │ │ │view to the object's class │ │ │ │default view, as returned │ │ │ │by wpclsQueryDefaultView. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │HELPLIBRARY │filename │This sets the help library.│ ├──────────────────┼────────────────────┼───────────────────────────┤ │HELPPANEL │id │This sets the object's │ │ │ │default help panel for │ │ │ │object-specific help. This │ │ │ │is equivalent to calling │ │ │ │wpSetDefaultHelp. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │HIDEBUTTON │YES │Views of this object have a│ │ │ │hide button as opposed to a│ │ │ │minimize button. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │Views of this object have a│ │ │ │minimize button as opposed │ │ │ │to a hide button. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │ │The default is the current │ │ │ │system Button appearance │ │ │ │for windows setting. This │ │ │ │cannot be specified here. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ICONFILE │filename │This sets the object's │ │ │ │icon. This is equivalent to│ │ │ │calling wpSetIconData. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ICONPOS │x,y │This sets the object's │ │ │ │initial icon position in a │ │ │ │folder. The x and y values │ │ │ │represent the position in │ │ │ │the object's folder in │ │ │ │percentage coordinates. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ICONRESOURCE │id,module │This sets the object's │ │ │ │icon. This is equivalent to│ │ │ │calling wpSetIconData. The │ │ │ │"id" is the icon resource │ │ │ │ID in the dynamic link │ │ │ │library (DLL) "module". │ ├──────────────────┼────────────────────┼───────────────────────────┤ │LOCKEDINPLACE │YES │This sets the object's icon│ │ │ │locked in place property, │ │ │ │so that the object's icon │ │ │ │is fixed in position in an │ │ │ │open icon view of the │ │ │ │folder containing the │ │ │ │object. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's │ │ │ │icon locked in place │ │ │ │property, so that the │ │ │ │object's icon position can │ │ │ │be moved. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │MENUITEMSELECTED │menu-item-ID │This simulates selecting │ │ │ │the specified menu item │ │ │ │from the object's pop-up │ │ │ │menu. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │MENUS │This sets the │ │ │ │object's pop-up menu│ │ │ │property to short │ │ │ │menus. │ │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │SHORT │This sets the object's │ │ │ │pop-up menu property to │ │ │ │long menus. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │MINWIN │HIDE │Views of this object hide │ │ │ │when their minimize button │ │ │ │is selected. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │VIEWER │Views of this object │ │ │ │minimize to the minimized │ │ │ │window viewer when their │ │ │ │minimize button is │ │ │ │selected. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │DESKTOP │Views of this object │ │ │ │minimize to the desktop │ │ │ │when their minimize button │ │ │ │is selected. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │ │The default is the current │ │ │ │Minimize button setting. │ │ │ │This cannot be specified │ │ │ │here. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOCOPY │YES │This sets the object's no │ │ │ │copy property, so that the │ │ │ │object cannot be copied. │ │ │ │This is equivalent to │ │ │ │calling wpSetStyle with a │ │ │ │style of OBJSTYLE_NOCOPY. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │copy property, so that the │ │ │ │object can be copied. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NODELETE │YES │This sets the object's no │ │ │ │delete property, so that │ │ │ │the object cannot be │ │ │ │deleted. This is equivalent│ │ │ │to calling wpSetStyle with │ │ │ │a style of │ │ │ │OBJSTYLE_NODELETE. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │delete property, so that │ │ │ │the object can be deleted. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NODRAG │YES │This sets the object's no │ │ │ │drag property, so that the │ │ │ │object cannot be dragged. │ │ │ │This is equivalent to │ │ │ │calling wpSetStyle with a │ │ │ │style of OBJSTYLE_NODRAG. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │drag property, so that the │ │ │ │object can be dragged. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NODROP │YES │This sets the object's no │ │ │ │drop property, so that no │ │ │ │other object can be dropped│ │ │ │on it. This is equivalent │ │ │ │to calling wpSetStyle with │ │ │ │a style of │ │ │ │OBJSTYLE_NODROPON. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │drop property, so that │ │ │ │another object can be │ │ │ │dropped on it. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOLINK │YES │This sets the object's no │ │ │ │link property, so that the │ │ │ │object cannot be linked. │ │ │ │This is equivalent to │ │ │ │calling wpSetStyle with a │ │ │ │style of OBJSTYLE_NOLINK. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │link property, so that the │ │ │ │object can be linked. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │ │This is the same as the │ │ │ │NOSHADOW keyword. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOMOVE │YES │This sets the object's no │ │ │ │move property, so that the │ │ │ │object cannot be moved. │ │ │ │This is equivalent to │ │ │ │calling wpSetStyle with a │ │ │ │style of OBJSTYLE_NOMOVE. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │move property, so that the │ │ │ │object can be moved. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOPRINT │YES │This sets the object's no │ │ │ │print property, so that the│ │ │ │object cannot be printed. │ │ │ │This is equivalent to │ │ │ │calling wpSetStyle with a │ │ │ │style of OBJSTYLE_NOPRINT. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │print property, so that the│ │ │ │object can be printed. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NORENAME │YES │This sets the object's no │ │ │ │rename property, so that │ │ │ │the object cannot be │ │ │ │renamed. This is equivalent│ │ │ │to calling wpSetStyle with │ │ │ │a style of │ │ │ │OBJSTYLE_NORENAME. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │rename property, so that │ │ │ │the object can be renamed. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOSETTINGS │YES │This sets the object's no │ │ │ │settings property, so that │ │ │ │the object' settings cannot│ │ │ │be opened. This is │ │ │ │equivalent to calling │ │ │ │wpSetStyle with a style of │ │ │ │OBJSTYLE_NOSETTINGS. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │settings property, so that │ │ │ │the object's settings can │ │ │ │be opened. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOSHADOW │YES │This sets the object's no │ │ │ │link property, so that the │ │ │ │object cannot be linked. │ │ │ │This is equivalent to │ │ │ │calling wpSetStyle with a │ │ │ │style of OBJSTYLE_NOLINK. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's no│ │ │ │link property, so that the │ │ │ │object can be linked. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │ │This is the same as the │ │ │ │NOLINK keyword. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │NOTVISIBLE │YES │This sets the object's not │ │ │ │visible property, so that │ │ │ │the object cannot be made │ │ │ │visible. This is equivalent│ │ │ │to calling wpSetStyle with │ │ │ │a style of │ │ │ │OBJSTYLE_NOTVISIBLE. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's │ │ │ │not visible property, so │ │ │ │that the object can be made│ │ │ │visible. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │OBJECTID │<name> │This sets a persistent ID │ │ │ │for the object. The │ │ │ │OBJECTID stays with the │ │ │ │object even if it is moved │ │ │ │or renamed. The object │ │ │ │pointer or handle can be │ │ │ │retrieved via │ │ │ │wpclsQueryObject or │ │ │ │WinQueryObject , │ │ │ │respectively. An OBJECTID │ │ │ │is any unique string │ │ │ │preceded with a "<" and │ │ │ │terminated with a ">". │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │ │The default is to not have │ │ │ │an ID. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │OPEN │SETTINGS │This opens the Settings │ │ │ │view when an object is │ │ │ │created or when │ │ │ │WinSetObjectData is called.│ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │DEFAULT │This opens the default view│ │ │ │when an object is created │ │ │ │or when WinSetObjectData is│ │ │ │called. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │ │The default is to not open │ │ │ │a view. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │TEMPLATE │YES │This sets the object's │ │ │ │template property. This is │ │ │ │equivalent to calling │ │ │ │wpSetStyle with a style of │ │ │ │OBJSTYLE_TEMPLATE. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │ │NO │This resets the object's │ │ │ │template property. │ │ │ │This is the default value. │ ├──────────────────┼────────────────────┼───────────────────────────┤ │TITLE │Title │This sets the object's │ │ │ │title. This is equivalent │ │ │ │to calling wpSetTitle. │ └──────────────────┴────────────────────┴───────────────────────────┘
Example
pszSetupString="TITLE=MYObject;"
"ICONFILE=myobj.ico;"
"HELPPANEL=132;"
"TEMPLATE=YES;"
"NODELETE=NO";
SOMObject instance methods
The following list shows 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.
Class Methods
The following list shows all the WPObject class methods:
SOMClass methods
The following list shows all the class methods overridden by the the WPObject class. These methods are overridden to modify the behavior defined by an ancestor class.