NAME
--background
DESCRIPTION
This class is used to display a progress window showing the user
what is currently going on while copying or moving files/directories.
TAGS
SCCA_FileTrans_Number (ULONG) -- Number of objects to move or copy.
Applicability is (I).
SCCA_FileTrans_Screen (struct Screen *) -- Screen to display to
file transfer progress window on.
Applicability is (I).
SCCA_FileTrans_ReplaceMode (ULONG) -- How to react if an object
to copy/move already exists at destination.
SCCV_ReplaceMode_Ask -- Pop up a requester and ask
the user what to do.
SCCV_ReplaceMode_Never -- Quietly skip the object and
proceed to the next one.
SCCV_ReplaceMode_Always -- Quietly overwrite the
existing object.
Applicability is (I). Defaults to SCCV_ReplaceMode_Ask.
NAME SYNOPSIS
LONG Result = DoMethod(obj,SCCM_FileTrans_Copy,BPTR srcLock,
BPTR destLock,CONST_STRPTR srcName,CONST_STRPTR destName,
LONG MouseX,LONG MouseY);
FUNCTION
Displays a window on the scalos screen containing some message about
the file currently being copied.
INPUTS
srcLock - Lock on copy source directory.
destLock - Lock on copy destination directory.
srcName - Name of object currently being copied from.
destName - Name of object currently being copied to.
MouseX,MouseY - position for destination icon.
RESULT
Result - 0 = RETURN_OK = copying finished successfully
5 = RETURN_WARN = Copying was aborted by user
... other DOS error code if something went wrong
NOTES
This function has special support for copying an entire volume to
a directory. To enable this functionality, srcName must be
empty ("", but not NULL), srcLock must be a Lock to the root of the
source volume, and destName must contain the volume name without
trailing colon.
SEE ALSO
NAME SYNOPSIS
LONG Result = DoMethod(obj,SCCM_FileTrans_Move,BPTR srcLock,
BPTR destLock,CONST_STRPTR Name,LONG MouseX,LONG MouseY);
FUNCTION
Displays a window on the scalos screen containing some message about
the file currently being moved.
INPUTS
srcLock - Lock on move source directory
destLock - Lock on move destination directory
Name - Name of object currently being moved
MouseX,MouseY - position for destination icon
RESULT
Result - 0 = RETURN_OK = moving finished successfully
5 = RETURN_WARN = moving was aborted by user
... other DOS error code if something went wrong
SEE ALSO
NAME
SCCM_FileTrans_CheckAbort
SYNOPSIS
LONG Result = DoMethod(obj,SCCM_FileTrans_CheckAbort);
FUNCTION
Checks if current file copy(move operation should be aborted
upon operator's request.
INPUTS
RESULT
Result - any non-zero value : Abort requested
SEE ALSO
NAME
SCCM_FileTrans_OpenWindow
SYNOPSIS
struct Window *Result = DoMethod(obj,SCCM_FileTrans_OpenWindow);
FUNCTION
Opens the file-transfer progress window.
INPUTS
RESULT
Result - a pointer to the file transfer progress window,
or NULL if window could not be opened.
SEE ALSO
NAME
SCCM_FileTrans_OpenWindowDelayed
SYNOPSIS
struct Window *Result = DoMethod(obj,SCCM_FileTrans_OpenWindowDelayed);
FUNCTION
Checks if the elapsed time after start of copy/move operations is
move than about 2 seconds.
If so, opens the file-transfer progress window.
INPUTS
RESULT
Result - a pointer to the file transfer progress window,
or NULL if window has not been opened.
SEE ALSO
NAME
SCCM_FileTrans_UpdateWindow
SYNOPSIS
DoMethod(obj,SCCM_FileTrans_UpdateWindow, ULONG UpdateMode,
BPTR SrcDirLock,BPTR DestDirLock,CONST_STRPTR Name);
FUNCTION
Updates the file transfer progress window.
First does a check if the window is already open. If the window is
open, the contents are updated. If it is not open,
SCCM_FileTrans_OpenWindowDelayed is called.
INPUTS
UpdateMode - Mode of window update
FTUPDATE_Initial - Initializes several things.
SrcDirLock, DestDirLock, and Name are ignored.
FTUPDATE_EnterNewDir - Display new "From" and "To" paths.
FTUPDATE_Entry - Display new filename
SrcDirLock and DestDirLock are ignored.
FTUPDATE_SameFile - only update progress gauge
SrcDirLock, DestDirLock, and Name are ignored.
FTUPDATE_Final - Update progress gauge to 100%,
SrcDirLock, DestDirLock, and Name are ignored.
SrcDirLock - Lock on copy/move source directory
DestDirLock - Lock on copy/move destination directory
Name - Name of object currently being copied or moved
SEE ALSO
NAME
SCCM_FileTrans_OverwriteRequest
SYNOPSIS
ULONG Result = DoMethod(obj,SCCM_FileTrans_OverwriteRequest, ULONG requestType,
BPTR srcLock, CONST_STRPTR srcName,
BPTR destLock, CONST_STRPTR destName,
struct Window *parentWindow,
ULONG bodyTextID, ULONG gadgetTextID);
FUNCTION
Pops up a requester telling the user that some file system object is
about to be overwritten. Ask user for decision about what to do,
and returns appropriate result.
INPUTS
requestType - type of operation
OVERWRITEREQ_Copy - file or directory is going to be copied
OVERWRITEREQ_Move - file or directory is going to be moved
OVERWRITEREQ_CopyIcon - icon is going to be copied
srcLock - Lock on source directory.
srcName - source name.
destLock - Lock on destination directory.
destName - destination name.
parentWindow - progress window on Scalos screen, may be NULL.
suggestedBodyTextId - Text ID from Scalos catalog that specifies suggested
requester body text.
suggestedGadgetTextId - Text ID from Scalos catalog that specifies
suggested requester gadget contents.
RESULT
Result - ExistsReqResult
EXISTREQ_Replace - replace only this object
EXISTREQ_Skip - don't replace and skip this object
EXISTREQ_ReplaceAll - replace this and any following object
EXISTREQ_Abort - abort copy/move operation
SEE ALSO
NAME
SCCM_FileTrans_CountTimeout
SYNOPSIS
ULONG Result = DoMethod(obj,SCCM_FileTrans_CountTimeout);
FUNCTION
Checks if counting of files (on file transfer start) takes longer
than the configured time (default: 10s),
returns non-zero value if timeout is exceeded and counting
should be aborted.
INPUTS
RESULT
Result - non-zero value if CountTimeout is exceeded and
counting should be aborted.
SEE ALSO