Class definition file: wpfolder.idl
Class hierarchy SOMObject
WPObject
WPFileSystem
WPFolder
Description
This is the folder object class. An instance of this class can be created as a Workplace object. An instance of this class is created initially by the system in its template form. It has the title "Folder" and resides in the "Templates" folder. Every directory in the system is represented by a WPFolder object.
Menu ID list
The following list shows the WPMENUID menu IDs for this class:
Menu item text
Instance methods
The following list shows how all the WPFolder methods are related within functional areas:
Settings notebook methods
Object position methods
Folder attributes methods
Folder state methods
Folder notification methods
Folder content methods
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.
WPObject instance methods
The following list shows all the methods overridden by the WPFolder class. These methods are overridden in order to modify the behavior defined by an ancestor class.
wpSetup override by WPFolder
The following table shows the keyname-value pairs supported by the WPFolder class.
┌─────────────────────────┬──────────────────┬───────────────────────────────────┐│KEYNAME │VALUE │DESCRIPTION │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ALWAYSSORT │YES │Sort order is always maintained. │
│ │ │Opening and adding an object to a │
│ │ │folder may take longer if the sort │
│ │ │order is being maintained. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │Sort order is not maintained. │
│ │ │This is the default value. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│BACKGROUND │N,M,S,B,C │This sets the folder background, │
│ │ │where: │
│ │ │N = Image file name. This │
│ │ │ name must be the fully- │
│ │ │ qualified path of the │
│ │ │ image file. "(none)" │
│ │ │ or "?:\" is │
│ │ │ permitted to indicate the │
│ │ │ boot drive. │
│ │ │ │
│ │ │M = Image mode. This mode can │
│ │ │ be one of the following: │
│ │ │ N = Normal image │
│ │ │ T = Titled image │
│ │ │ S = Scaled image │
│ │ │ │
│ │ │S = Scaling factor. │
│ │ │ │
│ │ │B = Background type. This can │
│ │ │ be one of the following: │
│ │ │ I = Image │
│ │ │ C = Color only │
│ │ │ │
│ │ │C = Background color. This │
│ │ │ color can be 3 numbers re- │
│ │ │ presenting RGB values or │
│ │ │ the default, in the │
│ │ │ following format: │
│ │ │ │
│ │ │ {R-value G-value B-value} │
│ │ │ │
│ │ │For example: │
│ │ │"BACKGROUND= │
│ │ │C:\OS2\BITMAP\OS2LOGO.BMP,S, │
│ │ │3,I" │
│ │ │or │
│ │ │"BACKGROUND= │
│ │ │(none),,,C,0 128 128" │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DEFAULTSORT │index │This sets the default sort │
│ │ │attribute on the sort menu. The │
│ │ │index value specifies the index │
│ │ │number of the details data item to │
│ │ │be used as the default sort │
│ │ │property. For example, if this │
│ │ │keyname is set to 0, the folder's │
│ │ │popup menu sort option has the │
│ │ │first item checked. │
│ │ │The default is set to 0. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DEFAULTVIEW │ICON │This sets the default open view to │
│ │ │the ICON (or CONTENTS) view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │TREE │This sets the default open view to │
│ │ │the TREE view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │DETAILS │This sets the default open view to │
│ │ │the DETAILS view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │ │The default view of the containing │
│ │ │folder. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DETAILSCLASS │classname │This sets the object class for │
│ │ │which the details are displayed in │
│ │ │details view. │
│ │ │The default object class is │
│ │ │WPFileSystem. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DETAILSFONT │fontname │Specifies the font to be used in │
│ │ │details view. For example: 10.Helv│
│ │ │The default value is 8.Helv. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DETAILSSHADOWCOLOR │color │This sets the color of the text for│
│ │ │a shadow object in details view. │
│ │ │The color value may be the name of │
│ │ │a color or 3 numbers representing │
│ │ │RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DETAILSTEXTCOLOR │color │This set the color of the text for │
│ │ │a normal object in details view. │
│ │ │The color value may be the name of │
│ │ │a color or 3 numbers representing │
│ │ │RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DETAILSTODISPLAY │index[,...] │This sets the details to be │
│ │ │displayed for a given class. The │
│ │ │index is the column index, starting│
│ │ │at 0, of the field to display. For │
│ │ │example, "DETAILSTODISPLAY=0,2" │
│ │ │specifies that only the first and │
│ │ │third details data items are to be │
│ │ │displayed. │
│ │ │The default value is to display all│
│ │ │fields. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│DETAILSVIEW │NORMAL │This specifies normal size icons. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │MINI │This specifies small icons. │
│ │ │This is the default. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONFONT │fontname │Specifies the font to be used in │
│ │ │icon view. For example: 10.Helv │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONNFILE │index,filename │This sets the file name of the │
│ │ │animation (open folder) icon. The │
│ │ │"index" value must be set to 1. The│
│ │ │specified file contains the │
│ │ │folder's open folder icon. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONGRIDSIZE │ │This sets the icon spacing for icon│
│ │ │view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONFILE │index,filename │This sets the animation icon to be │
│ │ │used for this folder. Filename │
│ │ │specifies the .ICO file containing │
│ │ │the icon. The value of index must │
│ │ │be 1 (indicating the open folder │
│ │ │icon). │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONNRESOURCE │index,id,modname │This sets the resource of the │
│ │ │animation (open folder) icon. The │
│ │ │"index" value must be set to 1. The│
│ │ │"id" is the identity of an icon │
│ │ │resource in the "module" dynamic │
│ │ │link library (DLL). The specified │
│ │ │resource is the folder's open │
│ │ │folder icon. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONSHADOWCOLOR │color │This sets the color of the text │
│ │ │associated with the shadow icons in│
│ │ │icon view. The color value may be │
│ │ │the name of a color or 3 numbers │
│ │ │representing RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONTEXTBACKGROUNDCOLOR │color │This sets the color of the │
│ │ │background for all normal text │
│ │ │displayed in icon view, tree view │
│ │ │and details view. The color value │
│ │ │may be the name of a color or 3 │
│ │ │numbers representing RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONTEXTCOLOR │color │This sets the color of the text │
│ │ │associated with normal icons in │
│ │ │icon view. The color value may be │
│ │ │the name of a color or 3 numbers │
│ │ │representing RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONTEXTVISIBLE │YES │This sets the icon text visible │
│ │ │property, so that the names of the │
│ │ │objects contained within the folder│
│ │ │are displayed in icon view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │This resets the icon text visible │
│ │ │property, so that the names of the │
│ │ │objects are not displayed. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONVIEW │s1[,s2,...sn] │This sets icon view to the │
│ │ │specified styles. Possible values │
│ │ │are: │
│ │ │GRIDDED or NONGRID │
│ │ │FLOWED or NONFLOWED │
│ │ │MINI, NORMAL or INVISIBLE │
│ │ │ │
│ │ │The default value is NONGRID,NORMAL│
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ICONVIEWPOS │x,y,cx,cy │This sets the initial icon view │
│ │ │position and size of the folder on │
│ │ │the screen. These values are │
│ │ │percentages (0-100) of the screen │
│ │ │size. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│MENUBAR │YES │This sets the menu bar property, so│
│ │ │that the menu bar is displayed in │
│ │ │an open view of the folder. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │This resets the menu bar propert, │
│ │ │so that the menu bar is not │
│ │ │displayed. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│OPEN │ICON │This opens the icon view when │
│ │ │object is created or when │
│ │ │WinSetObjectData is called. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │TREE │This opens the tree view when │
│ │ │object is created or when │
│ │ │WinSetObjectData is called. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │DETAILS │This opens the details view when │
│ │ │object is created or when │
│ │ │WinSetObjectData is called. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │ │The default is to not automatically│
│ │ │open a view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│REMOVEFONTS │YES │This removes all instance fonts │
│ │ │from the folder. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │This does not remove instance fonts│
│ │ │from the folder. │
│ │ │This is the default value. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│SHOWALLINTREEVIEW │YES │This set the show all in tree view │
│ │ │property, so that all objects are │
│ │ │displayed in an open tree view of │
│ │ │the folder. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │This resets the show all in tree │
│ │ │view property, so that only folders│
│ │ │are displayed in an open tree view │
│ │ │of the folder. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│SORTBYATTR │index[,...] │This sets the attributes to sort │
│ │ │by. Index specifies a list of index│
│ │ │numbers of details data to be shown│
│ │ │in the "Sort by Attribute" list for│
│ │ │the folder. For example, │
│ │ │"SORTBYATTR=0,2" specifies that │
│ │ │only the first and third details │
│ │ │data items are to be shown as │
│ │ │potential sort properties. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│SORTCLASS │classname │This sets the class object to sort │
│ │ │by. │
│ │ │The default class object is │
│ │ │WPFileSystem. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│TREEFONT │fontname │This specifies the font to be used │
│ │ │in tree view. For example: │
│ │ │10.System Proportional │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│TREESHADOWCOLOR │color │This sets the color of the text │
│ │ │associated with the shadow icons in│
│ │ │tree view. The color value may be │
│ │ │the name of a color or 3 numbers │
│ │ │representing RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│TREETEXTCOLOR │color │This sets the color of the text │
│ │ │associated with normal icons in │
│ │ │tree view. The color value may be │
│ │ │the name of a color or 3 numbers │
│ │ │representing RBG values. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│TREETEXTVISIBLE │YES │This sets the text visible in tree │
│ │ │view property, so that the names of│
│ │ │the objects contained within the │
│ │ │folder are displayed in tree view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │This resets the text visible in │
│ │ │tree view property, so that the │
│ │ │names of the objects are not │
│ │ │displayed. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│TREEVIEW │s1[,s2,...sn] │This sets the tree view to the │
│ │ │specified styles. Possible values │
│ │ │are: │
│ │ │INVISIBLE LINES │
│ │ │MINI NOLINES │
│ │ │NORMAL │
│ │ │ │
│ │ │The default value is LINES, NORMAL.│
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│view styles │FLOWED │Flowed list items. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NONFLOWED │Non-flowed list items. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NONGRID │Non-gridded icon view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NORMAL │Normal size icons. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │MINI │Small icons. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │INVISIBLE │No icons. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │LINES │Lines in tree view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NOLINES │No lines in tree view. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│WORKAREA │YES │This sets the folder so it is a │
│ │ │workarea. │
├─────────────────────────┼──────────────────┼───────────────────────────────────┤
│ │NO │This sets the folder so it is not a│
│ │ │workarea. This is the default │
│ │ │value. │
└─────────────────────────┴──────────────────┴───────────────────────────────────┘
WPFileSystem instance methods
The following list shows all the methods overridden by the WPFolder class. These methods are overridden in order to modify the behavior defined by an ancestor class.
Class methods
The following list shows all the WPFolder class methods:
WPObject class methods
The following list shows all the class methods overridden by the WPFolder class. These methods are overridden to modify the behavior defined by an ancestor class.