NAME
--background
DESCRIPTION
This class implements the functionality for the common workbench
icon windows.
NAME
SCCM_IconWin_ActivateIconDown
SYNOPSIS
DoMethod(obj,SCCM_IconWin_ActivateIconDown);
FUNCTION
Starting from the first icon currently selected, the icon located
directly below the selected will be activated.
If there is no icon selected, or the selected icon is located in
the bottommost row, the method is a no-op.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ActivateIconUp
SCCM_IconWin_ActivateIconLeft
SCCM_IconWin_ActivateIconRight
NAME
SCCM_IconWin_ActivateIconLeft
SYNOPSIS
DoMethod(obj,SCCM_IconWin_ActivateIconLeft);
FUNCTION
Starting from the first icon currently selected, the icon located
directly left of the selected will be activated.
If there is no icon selected, or the selected icon is located in
the leftmost column, the method is a no-op.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ActivateIconDown
SCCM_IconWin_ActivateIconUp
SCCM_IconWin_ActivateIconRight
NAME
SCCM_IconWin_ActivateIconNext
SYNOPSIS
DoMethod(obj,SCCM_IconWin_ActivateIconNext);
FUNCTION
Starting from the first icon currently selected, the icon which
alphabetically follows the name of the selected one
will be activated.
If there is no icon selected, the alphabetically first
icon will be selected.
If the currently activated icon is the alphabetically last one in
the window, this method will wrap around and activate the
alphabetically first one.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ActivateIconPrevious
NAME
SCCM_IconWin_ActivateIconPrevious
SYNOPSIS
DoMethod(obj,SCCM_IconWin_ActivateIconPrevious);
FUNCTION
Starting from the first icon currently selected, the icon which
alphabetically precedes the name of the selected one
will be activated.
If there is no icon selected, the alphabetically last
icon will be selected.
If the currently activated icon is the alphabetically first one in
the window, this method will wrap around and activate the
alphabetically last one.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ActivateIconNext
NAME
SCCM_IconWin_ActivateIconRight
SYNOPSIS
DoMethod(obj,SCCM_IconWin_ActivateIconRight);
FUNCTION
Starting from the first icon currently selected, the icon located
directly right of the selected will be activated.
If there is no icon selected, or the selected icon is located in
the rightmost column, the method is a no-op.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ActivateIconDown
SCCM_IconWin_ActivateIconUp
SCCM_IconWin_ActivateIconLeft
NAME
SCCM_IconWin_ActivateIconUp
SYNOPSIS
DoMethod(obj,SCCM_IconWin_ActivateIconUp);
FUNCTION
Starting from the first icon currently selected, the icon located
directly above the selected will be activated.
If there is no icon selected, or the selected icon is located in
the topmost row, the method is a no-op.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ActivateIconDown
SCCM_IconWin_ActivateIconLeft
SCCM_IconWin_ActivateIconRight
NAME SYNOPSIS
DoMethod(obj,SCCM_IconWin_AddGadget,struct Gadget *g);
FUNCTION
Inserts a user-supplied Intuition Gadget at the front
of the internal Gadget list.
INPUTS
Gadget - User-supplied Gadget
SEE ALSO
NAME SYNOPSIS
struct ScaIconNode *icon = DoMethod(obj,SCCM_IconWin_AddIcon,
WORD x,WORD y,BPTR Lock,CONST_STRPTR Name);
FUNCTION
Causes a window task to load the specified selected icon.
INPUTS
x - icon x position or $8000 for any position
y - icon y position
Lock - Lock on icon directory
Name - icon name
RESULT
icon - newly added ScaIconNode or NULL if something went wrong.
SEE ALSO
NAME
SCCM_IconWin_AddToStatusBar
SYNOPSIS
DoMethod(obj,SCCM_IconWin_AddToStatusBar,struct Gadget *g,
ULONG Tag, ...);
FUNCTION
Adds a new BOOPSI gadget to the window status bar.
INPUTS
g - new Gadget to be added
Tag - Taglist
SEE ALSO
SCCM_IconWin_RemFromStatusBar
NAME
SCCM_IconWin_ScheduleUpdate
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_ScheduleUpdate);
FUNCTION
Schedule a check of the window for updated files and perform
updates, including adding and removing icons.
This real update check will be delayed for about 2 seconds in
order to avoid many rapidly repeated window updates, and is done
via the SCCM_IconWin_ImmediateCheckUpdate method.
These 2 seconds are restarted with each new
SCCM_IconWin_ScheduleUpdate invokation.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_ImmediateCheckUpdate
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_CleanUp);
FUNCTION
Fits all window icons to free positions, including icons in
wt_LateIconList. Prevents icons from overlapping each other.
INPUTS
RESULT
SEE ALSO
NAME
SCCM_IconWin_CleanUpByDate
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_CleanUpByDate);
FUNCTION
Sorts all window icons descending by date, and fits them to free
positions, including icons in wt_LateIconList.
Prevents icons from overlapping each other.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_CleanUpByName
SCCM_IconWin_CleanUpBySize
SCCM_IconWin_CleanUpByType
NAME
SCCM_IconWin_CleanUpByName
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_CleanUpByName);
FUNCTION
Sorts all window icons ascending by name, and fits them to free
positions, including icons in wt_LateIconList.
Prevents icons from overlapping each other.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_CleanUpByDate
SCCM_IconWin_CleanUpBySize
SCCM_IconWin_CleanUpByType
NAME
SCCM_IconWin_CleanUpBySize
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_CleanUpBySize);
FUNCTION
Sorts all window icons ascending by size, and fits them to free
positions, including icons in wt_LateIconList.
Prevents icons from overlapping each other.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_CleanUpByDate
SCCM_IconWin_CleanUpByName
SCCM_IconWin_CleanUpByType
NAME
SCCM_IconWin_CleanUpByType
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_CleanUpByType);
FUNCTION
Sorts all window icons ascending by type, and fits them to free
positions, including icons in wt_LateIconList.
Prevents icons from overlapping each other.
INPUTS
RESULT
SEE ALSO
SCCM_IconWin_CleanUpByDate
SCCM_IconWin_CleanUpByName
SCCM_IconWin_CleanUpBySize
NAME
SCCM_IconWin_ClearIconFileTypes
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_ClearIconFileTypes);
FUNCTION
Clears the filetype information for all windows in the icon
window. Useful if filetype information hasd changed
and has to be re-read.
INPUTS
RESULT
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_DeltaMove,LONG deltaX,LONG deltaY);
FUNCTION
Moves window interior by (deltaX,deltaY) and adjusts
scrollers accordingly.
INPUTS
deltaX - movement in horizontal direction
deltaY - movement in vertical direction
RESULT
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_DragDrop,struct Window *dropWindow,
ULONG mouseX,ULONG mouseY,ULONG Qualifier);
FUNCTION
Drops all dragged icons into (dropWindow) at coordinates
(mouseX,MouseY).
INPUTS
dropWindow - Intuition window to drop in
mouseX - mouse x position from IntuiMessage
mouseY - mouse y position from IntuiMessage
Qualifier - qualifier position from IntuiMessage
RESULT
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_DragEnter, struct ScaWindowStruct *StartWin,
struct ScaIconNode *Icon, ULONG MouseX, ULONG MouseY)
FUNCTION
Signals destination window that mouse pointer with attached
icons has entered the window area (drage_Icon = NULL) or
now points to icon (drage_Icon).
INPUTS
StartWin - scalos window from which dragging started
Icon -icon under mouse pointer
MouseX, MouseY - mouse coordinates.
RESULT
NOTE
It is VERY IMPORTANT that every SCCM_IconWin_DragEnter (icon
or window) is paired with a corresponding
SCCM_IconWin_DragLeave method (icon or window) call !!!
SEE ALSO
NAME SYNOPSIS
BOOL DoMethod(obj,SCCM_IconWin_DragQuery, struct ScaWindowStruct *StartWin,
struct ScaIconNode *Icon, ULONG MouseX, ULONG MouseY)
FUNCTION
Check whether icons may be dropped into our window
or onto specified icon.
INPUTS
StartWin - scalos window from which dragging started
Icon -icon under mouse pointer
MouseX, MouseY - mouse coordinates.
RESULT
BOOL
TRUE yes, we may drop here
FALSE no, dropping not allowed
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_DragLeave, struct ScaWindowStruct *StartWin,
struct ScaIconNode *Icon, ULONG MouseX, ULONG MouseY);
FUNCTION
Signals destination window that mouse pointer with attached
icons has left the window area (drage_Icon = NULL) or
now points no longer to icon (drage_Icon).
INPUTS
StartWin - scalos window from which dragging started
Icon -icon under mouse pointer
MouseX, MouseY - mouse coordinates.
RESULT
NOTE
It is VERY IMPORTANT that every SCCM_IconWin_DragEnter (icon
or window) is paired with a corresponding
SCCM_IconWin_DragLeaveDrag method (icon or window) call !!!
SEE ALSO
NAME SYNOPSIS
ULONG Result = DoMethod(obj,SCCM_IconWin_DrawIcon,Object *IconObject);
FUNCTION
Draws (IconObject) in window by invoking IDTM_Draw method with icon
INPUTS
IconObject - Icon to be drawn
RESULT
Result - result from IDTM_Draw
SEE ALSO
NAME SYNOPSIS
Object *icon = DoMethod(obj,SCCM_IconWin_GetDefIcon,CONST_STRPTR Name,
LONG Type,ULONG Protection);
FUNCTION
Tries to get a default icon for the specified file. Calls
iconobject.library/GetDefIconObject and returns result.
INPUTS
Name - file name
Type - file type (fib_DirEntryType from FileInfoBlock)
Protection - file protection (fib_Protection from FileInfoBlock)
RESULT
icon - default Icon IconObject
SEE ALSO
iconobject.library/GetDefIconObject
NAME
SCCM_IconWin_GetIconFileType
SYNOPSIS
Object *icon = DoMethod(obj,SCCM_IconWin_GetIconFileType,
struct ScaIconNode *icon);
FUNCTION
Identifies object for icon, find the appropriate filetype
and setup the in_FileType member of ScaIconNode.
INPUTS
icon - icon to find filetype for.
RESULT
icon - default Icon IconObject
SEE ALSO
iconobject.library/GetDefIconObject
NAME
SCCM_IconWin_ImmediateCheckUpdate
SYNOPSIS
Object *icon = DoMethod(obj,SCCM_IconWin_ImmediateCheckUpdate);
FUNCTION
Scan directory associated to this window and check for any changes
between the display and the disk contents. If any changes are found,
icons are added, removed, or replaced as necessary.
INPUTS
SEE ALSO
SCCM_IconWin_ScheduleUpdate
NAME SYNOPSIS
ULONG Result = DoMethod(obj,SCCM_IconWin_LayoutIcon,Object *IconObject,
ULONG LayoutFlags);
FUNCTION
Prepares an IconObject to be rendered.
INPUTS
IconObject - icon to be layouted
LayoutFlags
IOLAYOUTB_NormalImage // Layout normal Image
IOLAYOUTB_SelectedImage // Layout selected Image
RESULT
Result - result from IDTM_Layout
SEE ALSO
NAME SYNOPSIS
ULONG Count = DoMethod(obj,SCCM_IconWin_MakeWBArg,
struct ScaIconNode *icon, struct WBArg *Buffer);
FUNCTION
Fill a WBArg structure (wa_Lock and wa_Name) from the given icon or
from the window.
INPUTS
icon - icon to make WBArg from
if icon = NULL, return WBArg with wa_Lock = copy of
window lock and wa_Name = NULL
Buffer - Result buffer with at least enough room for one WBArg.
RESULT
Count - number of successfully create WBArg's in (Buffer) (0 or 1).
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_MenuCommand,CONST_STRPTR CmdName,
struct ScaIconNode *icon, BOOL state);
FUNCTION
INPUTS
CmdName - command name
icon - icon to apply command to
state - ?
RESULT
SEE ALSO
NAME SYNOPSIS
Object *WindowObj = DoMethod(obj,SCCM_IconWin_NewViewMode,
ULONG ViewMode);
FUNCTION
changes window view mode from text to icon and vice versa.
INPUTS
ViewMode - new window view mode
RESULT
WindowObj - IconWindow.sca subclass object if window class
changes from text to icon or vice versa
NULL if window class is not changed.
SEE ALSO
NAME SYNOPSIS
BOOL Success = DoMethod(obj, SCCM_IconWin_Open, struct ScaIconNode *icon, ULONG Flags);
FUNCTION
perform "open" function on (icon)
INPUTS
icon - icon to open
Flags - ICONWINOPENF_IgnoreFileTypes -- always OPEN icon, ignore
file type settings.
RESULT
Success - TRUE if new window could be opened
FALSE if anything went wrong
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_RawKey,struct IntuiMessage *iMsg);
FUNCTION
Processes Intuition IDCMP_RAWKEY events.
INPUTS
RESULT
SEE ALSO
NAME SYNOPSIS
struct ScaIconNode *icon = DoMethod(obj,SCCM_IconWin_ReadIcon,
CONST_STRPTR name, struct ScaReadIconArg *ria);
FUNCTION
Read one icon, add it to the window icon list, and display it.
If an icon with the same name, already exists, it is replaced.
INPUTS
name - name of the icon
ria - pointer to struct ScaReadIconArg with information about x/y icon
position, and optional Lock on parent directory.
ria may be NULL.
RESULT
icon - newly created ScaIconNode or NULL if something went wrong.
SEE ALSO
NAME
SCCM_IconWin_ReadIconList
SYNOPSIS
BOOL Error = DoMethod(obj,SCCM_IconWin_ReadIconList,ULONG flags);
FUNCTION
Read all icons in directory into window.
INPUTS
flags - SCCV_IconWin_ReadIconList_ShowAll = show all files
RESULT
Error - non-zero value if anything went wrong
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_Redraw,ULONG flags);
FUNCTION
INPUTS
flags
REDRAWB_DontEraseWindow : don't erase window before redraw
REDRAWB_ReLayoutIcons : relayout icons
RESULT
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_RemIcon,BPTR Lock, CONSTR_STRPTR Name);
FUNCTION
Remove specified icon from window
INPUTS
Lock - Lock on icon directory
Name - Name of icon to remove
RESULT
SEE ALSO
NAME
SCCM_IconWin_RemFromStatusBar
SYNOPSIS
DoMethod(obj,SCCM_IconWin_RemFromStatusBar,struct Gadget *g);
FUNCTION
Remove specified Gadget from window status bar.
INPUTS
g - Gadget to remove from status bar
SEE ALSO
SCCM_IconWin_AddToStatusBar
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_SetVirtSize,ULONG Flags);
FUNCTION
Calculate bounding rectangle of all icons in window and optionally
adjust window scrollers accordingly.
INPUTS
Flags
SETVIRTF_AdjustRightSlider = adjust right (vertical) slider
SETVIRTF_AdjustBottomSlider = set bottom (horizontal) slider
RESULT
SEE ALSO
NAME
SCCM_IconWin_ShowIconToolTip
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_ShowGadgetToolTip, ULONG gadgetID);
FUNCTION
Display tool tip window for (gadgetID).
INPUTS
gadgetID - GadgetID of gadget to display tool tip for.
RESULT
SEE ALSO
NAME
SCCM_IconWin_ShowIconToolTip
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_ShowIconToolTip,
struct ScaIconNode *icon);
FUNCTION
Display icon tool tip window for (icon).
INPUTS
icon - icon to display tool tip for.
RESULT
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_Sleep);
FUNCTION
Iconify window and add AppIcon to Workbench.
INPUTS
RESULT
SEE ALSO
NAME SYNOPSIS
DoMethod(obj,SCCM_IconWin_Update);
FUNCTION
Re-read all icons into window and redraw window.
INPUTS
RESULT
SEE ALSO
NAME SYNOPSIS
DoMethod(obj,SCCM_IconWin_UpdateIcon,BPTR Lock,CONST_STRPTR Name);
FUNCTION
Update and redisplay icon.
INPUTS
Lock - Lock to icon directory
Name - name of icon
RESULT
SEE ALSO
NAME
SCCM_IconWin_UpdateStatusBar
SYNOPSIS
DoMethod(obj,SCCM_IconWin_UpdateStatusBar,struct Gadget *g,ULONG Tags,...);
FUNCTION
Update window status bar member gadget. Applies OM_SET method with
the supplied taglist to member gadget.
INPUTS
g - Status bar member gadget to update
Tags - Taglist
SEE ALSO
NAME SYNOPSIS
void DoMethod(obj,SCCM_IconWin_WakeUp,ULONG ReLayout);
FUNCTION
Uniconify and open iconified window.
INPUTS
ReLayout - TRUE if all icons of the window should be relayouted
RESULT
SEE ALSO
NAME
SCCM_IconWin_ShowPopupMenu
SYNOPSIS
void DoMethod(obj,SCCM_IconWin_ShowPopupMenu,
struct PopupMenu *pm, struct ScaIconNode *in,
ULONG Flags, struct FileTypeDef *fType);
FUNCTION
Show a popup menu and execute the user's menu command.
INPUTS
pm - Popup menu to display.
in - Scalos icon node the popup menu should be associated to.
Can be NULL for window popup menus.
Flags - Show which items are still locked and HAVE TO BE UNLOCKED
during processing.
SHOWPOPUPFLGF_IconSemaLocked - wt_IconSemaphore is still locked
SHOWPOPUPFLGF_WinListLocked - Scalos window list is still locked.
fType - Private data structure for support of file type specific
popup menus. Should be NULL if unused.
RESULT
SEE ALSO