A program or Workplace Shell object would call the following methods to get general information about an object. A Workplace Shell object would override these methods to define its characteristics.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │wpIdentify │Returns a string that is │ │ │unique within a given │ │ │container that identifies the │ │ │specified object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryConfirmations │Returns the set of │ │ │confirmations that are set for│ │ │this object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryDefaultHelp │Returns the object's default │ │ │help panel. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryNameClashOptions │Returns the set of options │ │ │that are not available on the │ │ │name clash dialog for this │ │ │object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryTitle │Returns the object's title. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryTrueStyle │Queries this object's current │ │ │class true style. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryDefaultHelp │Returns the class default help│ │ │panel. This help panel is used│ │ │for all objects of this class.│ │ │The default help panel can be │ │ │changed for an individual │ │ │object if: │ │ │ │ │ │o The object overrides │ │ │ wpQueryDefaultHelp. │ │ │o The wpSetDefaultHelp method │ │ │ is called. │ │ │o The wpSetup method is called│ │ │ with the HELPPANEL keyword. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQuerySetting │Returns a settings value for │ │ │an abstract class object. An │ │ │abstract class object would │ │ │override this method if it │ │ │saved its class settings. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryStyle │Returns the class style. See │ │ │Class Styles. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryTitle │Returns the class title. This │ │ │title is used for all objects │ │ │of this class, including the │ │ │class template. The title can │ │ │be changed for an individual │ │ │object if: │ │ │ │ │ │o The object overrides │ │ │ wpQueryTitle. │ │ │o The wpSetTitle method is │ │ │ called. │ │ │o The wpSetup method is │ │ │ called with the TITLE │ │ │ keyword, when the user │ │ │ edits the object's title │ │ │ on the General page of the │ │ │ Settings notebook, or when │ │ │ the user edits the │ │ │ object's title under │ │ │ the icon. │ └──────────────────────────────┴──────────────────────────────┘
A program or Workplace Shell object would call the following methods to get general information about an object. These methods are not normally overridden.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │wpFindTaskRec │An object is sent this message│ │ │to return information specific│ │ │to the task being performed in│ │ │a task thread. │ ├──────────────────────────────┼──────────────────────────────┤ │wpGetTrueClassName │Returns the class name for the│ │ │given object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryContainerFlagPtr │Returns the pointer to a flag │ │ │indicating whether or not the │ │ │object is in a container. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryCoreRecord │Returns the pointer to the │ │ │object's MINIRECORDCORE data │ │ │structure. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryDefaultIconPos │Returns the default icon │ │ │position used when this object│ │ │is first inserted into a │ │ │folder. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryError │Returns the last error code │ │ │set by calling the object's │ │ │wpSetError. This is normally │ │ │an error code being returned │ │ │by a failing instance method. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFolder │Returns the object pointer for│ │ │the folder containing the │ │ │object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryHandle │Returns the object's unique │ │ │persistent handle. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryObjectID │Returns the object's │ │ │identifier. The object │ │ │identifier is set by calling │ │ │wpSetObjectID for the object │ │ │or by calling wpSetup for the │ │ │object with the OBJECTID │ │ │keyword. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryScreenGroupID │Returns the screen group │ │ │identifier of the application │ │ │running for this object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryStyle │Returns the object's current │ │ │style flags. See Object Styles│ │ │. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryStyle │Returns the object's style. │ │ │See Object Styles. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryError │Returns the last error code │ │ │set by calling the class' │ │ │wpclsSetError. This is │ │ │normally an error code that is│ │ │returned by a failing class │ │ │method. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryFolder │Returns the pointer to the │ │ │folder object that corresponds│ │ │to the specified file system │ │ │path. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryObject │Returns the pointer to the │ │ │object that corresponds to the│ │ │specified persistent object │ │ │handle. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryStyle │Returns the object class' │ │ │style. See Class Styles. │ └──────────────────────────────┴──────────────────────────────┘
A program or Workplace Shell object would call the following methods to set general information about an object. These methods are not normally overridden.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │wpModifyStyle │Sets or clears individual │ │ │flags within the object's │ │ │style. This method call is an │ │ │atomic operation as only the │ │ │specified style flags are │ │ │changed, even if other running│ │ │threads try to modify the │ │ │style flags at the same time. │ │ │See Object Styles. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetDefaultHelp │Sets the object's default help│ │ │panel. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetDefaultIconPos │Sets the object's default icon│ │ │position which is used when it│ │ │is inserted into a folder. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetError │Sets the current error code │ │ │for the object. This method is│ │ │normally called by an instance│ │ │method to pass an error code │ │ │back to the caller. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetObjectID │Sets the object's identifier. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetStyle │Sets the object's style. This │ │ │method exists only for │ │ │compatibility with old │ │ │objects. All new or changed │ │ │objects should use │ │ │wpModifyStyle instead. See │ │ │Object Styles. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetTaskRec │Adds, replaces, or deletes a │ │ │task data block. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetTitle │Sets the object's title. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsSetError │Sets the current error code │ │ │for the class. This method is │ │ │normally called by a class │ │ │method to pass an error code │ │ │back to the caller. │ └──────────────────────────────┴──────────────────────────────┘
A program or Workplace Shell object would call the following method to set general information about an object. A Workplace Shell object would override this method to define its characteristics.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryInstanceClass │Returns the name of a class │ │ │that this object can become. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsSetSetting │Sets a settings value for an │ │ │abstract class object. An │ │ │abstract class object would │ │ │override this method if it │ │ │wants to save its class │ │ │settings. │ └──────────────────────────────┴──────────────────────────────┘