A program or Workplace Shell object would call the following methods to get information about a folder object. These methods are not normally overridden.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │wpInitIconPosData │Reads the .ICONPOS extended │ │ │attribute (EA) for the folder │ │ │directory to determine where │ │ │to position the object icons │ │ │within the folder. │ ├──────────────────────────────┼──────────────────────────────┤ │wpIsDetailsColumnVisible │Returns the visibility state │ │ │of a specified Details view │ │ │column of the folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpIsSortAttribAvailable │Returns an indication of │ │ │whether or not a sort │ │ │attribute is available for a │ │ │column of the Details view of │ │ │the folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryContent │Returns the pointer to an │ │ │object contained in the │ │ │folder. This method may be │ │ │called within a loop to │ │ │enumerate all of the objects │ │ │contained in the folder. │ │ │ │ │ │Note: │ │ │The folder must be awake for │ │ │this method to return the │ │ │pointers to all objects │ │ │contained in the folder. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrAttr │Returns the folder object's │ │ │attributes. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrBackground │Returns the current values for│ │ │the folder background. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrDetailsClass │Returns the class for which │ │ │data is displayed in the │ │ │Details view of the folder │ │ │object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrFlags │Returns the current state of │ │ │the folder object's flags. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrFont │Returns the name of the font │ │ │used for the specified view of│ │ │the folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrSort │Returns the sort attribute │ │ │used for the specified view of│ │ │the folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryFldrSortClass │Returns the object class for │ │ │which sorting is performed for│ │ │the folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │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. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryIconViewPos │Returns a pointer to the │ │ │IconViewPos array of the │ │ │folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryMenuBarVisibility │Returns the visibility state │ │ │of the folder's menu bar. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryMenuStyle │Returns the current menu │ │ │style, which is either long or│ │ │short. │ ├──────────────────────────────┼──────────────────────────────┤ │wpQueryNextIconPos │Returns the next position at │ │ │which an icon is inserted into│ │ │the folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │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. │ ├──────────────────────────────┼──────────────────────────────┤ │wpclsQueryOpenFolders │Returns the pointer to an open│ │ │folder object. This method may│ │ │be called in a loop to │ │ │enumerate all currently open │ │ │folders. │ └──────────────────────────────┴──────────────────────────────┘
A program or Workplace Shell object would call the following methods to set information about a folder object. These methods are not normally overridden.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │wpModifyFldrFlags │Sets or clears individual │ │ │flags within the folder │ │ │object. │ │ │ │ │ │Note: │ │ │This method is an atomic │ │ │operation as only the │ │ │specified flags are changed, │ │ │even if other running threads │ │ │try to modify the flags at │ │ │the same time. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetDetailsColumnVisibility │Changes the visibility state │ │ │of a specified column of data │ │ │for the Details view of the │ │ │folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrAttr │Changes the folder object's │ │ │attributes. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrBackground │Sets the values for the folder│ │ │background. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrDetailsClass │Changes the object class for │ │ │which data is displayed in a │ │ │Details view of the folder │ │ │object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrFlags │Changes the folder object's │ │ │flags. │ │ │ │ │ │Note: │ │ │This method exists only for │ │ │compatibility with old │ │ │objects. All new or changed │ │ │objects should use │ │ │wpModifyFldrFlags instead. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrFont │Changes the font used for the │ │ │specified view of the folder │ │ │object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrSort │Changes the sort attribute for│ │ │the specified view of the │ │ │folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFldrSortClass │Changes the object class for │ │ │which data is sorted for the │ │ │folder object. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetFolder │Sets this object to reside in │ │ │the specified folder. │ ├──────────────────────────────┼──────────────────────────────┤ │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. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetNextIconPos │Changes the next position at │ │ │which an icon is inserted into│ │ │the folder object. This method│ │ │can be used to ensure that │ │ │objects inserted into the │ │ │folder are displayed where you│ │ │want them. │ ├──────────────────────────────┼──────────────────────────────┤ │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. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetShadowTextColor │Sets the color to be used for │ │ │the shadow text for the │ │ │specified view. │ ├──────────────────────────────┼──────────────────────────────┤ │wpSetSortAttribAvailable │Changes the indication of │ │ │whether or not a sort │ │ │attribute is available for a │ │ │column of a Details view of │ │ │the folder object. │ └──────────────────────────────┴──────────────────────────────┘
A program or Workplace Shell object would call the following methods to flush notification messages or free icon position data for a folder object. These methods are not normally overridden.
┌──────────────────────────────┬──────────────────────────────┐ │Method Name │Description │ ├──────────────────────────────┼──────────────────────────────┤ │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. │ └──────────────────────────────┴──────────────────────────────┘