переведено nOT^LkR, извиняюсь за некоторую корявость, все же

переведено nOT^LkR, извиняюсь за некоторую корявость, все же
не приспособлен русский для таких описаний - терминов не хватает :-)
dopus5.library/CheckProgressAbort
dopus5.library/CheckProgressAbort
ИМЯ ФУНКЦИИ
CheckProgressAbort - проверяет, была ли прервана работа
ИСПОЛЬЗОВАНИЕ
CheckProgressAbort(handle)
A0
BOOL CheckProgressAbort(APTR);
ОПИСАНИЕ
Позволяет проверить состояние флага прерывания (abort) в
указанном индикаторе
(progress window).
ВХОДНЫЕ ДАННЫЕ
handle - handle индикатора (progress window)
РЕЗУЛЬТАТ
Возвращает TRUE, если была нажата кнопка отмены (Abort).
СМ. ТАКЖЕ
OpenProgressWindow()
dopus5.library/CloseProgressWindow
dopus5.library/CloseProgressWindow
ИМЯ ФУНКЦИИ
CloseProgressWindow - закрывает индикатор (progress window)
ИСПОЛЬЗОВАНИЕ
CloseProgressWindow(handle)
A0
void CloseProgressWindow(APTR);
ОПИСАНИЕ
Закрывает указанный индикатор (progress window).
ВХОДНЫЕ ДАННЫЕ
handle - индикатор, который нужно закрыть
СМ. ТАКЖЕ
OpenProgressWindow()
dopus5.library/GetProgressWindow
dopus5.library/GetProgressWindow
ИМЯ ФУНКЦИИ
GetProgressWindow - получает информацию об индикаторе (progress
window)
ИСПОЛЬЗОВАНИЕ
GetProgressWindow(handle, tags)
A0
A1
void GetProgressWindow(APTR, struct TagItem *);
void GetProgressWindowTags(APTR, Tag, ...);
ОПИСАНИЕ
Возвращает информацию об индикаторе (progress window). На данный
момент информация такова :
PW_Window
- возвращает указатель на окно (Window)
ВХОДНЫЕ ДАННЫЕ
handle - handle индикатора (progress window)
tags
- запрашиваемые tag'и
РЕЗУЛЬТАТ
Результат запроса о каждом tag'е хранится в поле ti_Data
соответствующего TagItem.
СМ. ТАКЖЕ
OpenProgressWindow(), SetProgressWindow()
dopus5.library/HideProgressWindow
dopus5.library/HideProgressWindow
ИМЯ ФУНКЦИИ
HideProgressWindow - скрывает (hide) индикатор (progress window)
ИСПОЛЬЗОВАНИЕ
HideProgressWindow(handle)
A0
void HideProgressWindow(APTR);
ОПИСАНИЕ
Убирает отображение индикатора на экране. Индикатор по-прежнему
действует, его можно обновлять и закрывать, даже если он скрыт.
ВХОДНЫЕ ДАННЫЕ
handle - handle индикатора (progress window)
СМ. ТАКЖЕ
OpenProgressWindow(), ShowProgressWindow()
dopus5.library/OpenProgressWindow
dopus5.library/OpenPRogressWindow
ИМЯ ФУНКЦИИ
OpenProgressWindow - открывает индикатор (progress window)
ИСПОЛЬЗОВАНИЕ
OpenProgressWindow(tags)
A0
APTR OpenProgressWindow(struct TagItem *);
APTR OpenProgressWindowTags(Tag, ...);
ОПИСАНИЕ
Открывает индикатор (progress window), который можно использовать
для
отображения прогресса различных операций. Индикатор может
содержать
имя файла, счетчик числа файлов и шкалу (gauge).
ВХОДНЫЕ ДАННЫЕ
tags - контрольные tag'и. Могут быть следующими :
PW_Screen
- экран. Индикатор откроется в центре этого
экрана. Этот tag отменяет действие PW_Window.
PW_Window
- окно. Индикатор откроется в центре поверх
PW_Title
- заголовок индикатора
этого окна.
PW_SigTask
кнопки отмены
- задача, которой придет сигнал в случае нажатия
PW_SigBit
- бит, который будет послан задаче в качестве
сигнала
(именно бит, не маска)
PW_FileName
- начальное имя файла
PW_FileSize
- начальный размер файла
PW_FileCount - начальное число файлов
PW_Flags
- контрольные флаги
tag PW_Flags может содержать :
PWF_FILENAME
PWF_FILESIZE
PWF_INFO
PWF_GRAPH
PWF_NOABORT
-
если
если
если
если
если
нужно отображение имени файла
нужно отображение размера файла (1)
нужно отображение строки с информацией
нужно отображение в виде шкалы (1)
не нужна кнопка отмены (Abort) (2)
PWF_INVISIBLE - чтобы индикатор открылся 'скрытым'
(чтобы он стал виден, нужно вызвать
ShowProgressWindow())
PWF_ABORT
- если нужна кнопка отмены (Abort) (2)
1. Обычно размер файла выводится как "xxxxxx байт" в правом
верхнем
углу индикатора, а шкала используется для отображения "x из y
файлов".
Если же указать и PWF_FILESIZE, и PWF_GRAPH, эти действия
изменятся.
Прогресс для текущего файла (например, число скопированных
байт)
отображает шкала, а прогресс текущей операции (например, число
скопированных
файлов) будет отображаться справа вверху.
2. Если указать задачу с помощью флага pw_SigTask, индикатор
автоматически
откроется с кнопкой отмены. Чтобы этого не произошло, нужно
указывать
флаг PWF_NOABORT.
Если флаг pw_SigTask не указан, флаг PWF_ABORT позволяет
добавить кнопку
отмены, не посылающую сигнала (ее нажатие нужно проверять
через
CheckProgressAbort()).
РЕЗУЛЬТАТ
Возвращает handle на созданный индикатор или NULL случае ошибки.
СМ. ТАКЖЕ
SetProgressWindow(), CloseProgressWindow()
dopus5.library/SetProgressWindow
dopus5.library/SetProgressWindow
ИМЯ ФУНКЦИИ
SetProgressWindow - обновляет состояние индикатора
ИСПОЛЬЗОВАНИЕ
SetProgressWindow(handle, tags)
A0
A1
void SetProgressWindow(APTR, struct TagItem *);
void SetProgressWindowTags(APTR, Tag, ...);
ОПИСАНИЕ
Эта функция позволяет обновить состояние индикатора.
ВХОДНЫЕ ДАННЫЕ
handle - handle индикатора (progress window)
tags
- контрольные tag'и. Могут быть следующими :
PW_Title
- изменять заголовок окна
PW_FileName
- изменять отображаемое имя файла
PW_FileSize
- изменять общий размер текущего файла
PW_FileDone
- изменять "обработанный" размер текущего
файла
(например, если размер файла 12800 и
половина его
уже скопирована, "обработанный" размер будет 6400).
PW_Info
- изменять строку информации
PW_FileCount
- изменять общее число файлов
PW_FileNum
- изменять число обработанных файлов
(например,
если всего файлов 84 и четверть уже
обработана,
текущий номер файла будет 21).
РЕЗУЛЬТАТ
Изменения отображаются немедленно. Если индикатор "скрыт",
изменения все
равно происходят и станут видны как только индикатор будет открыт.
СМ. ТАКЖЕ
OpenProgressWindow()
dopus5.library/ShowProgressWindow
dopus5.library/ShowProgressWindow
ИМЯ ФУНКЦИИ
ShowProgressWindow - открыть "скрытый" индикатор
ИСПОЛЬЗОВАНИЕ
ShowProgressWindow(handle, screen, window)
A0
A1
A2
void ShowProgressWindow(APTR, struct Screen *, struct Window *);
ОПИСАНИЕ
Открывает индикатор, "скрытый" через HideProgressWindow().
ВХОДНЫЕ ДАННЫЕ
handle - handle индикатора (progress window)
screen - новый "родительский" (parent) экран (если не указано
окно)
window - новое "родительское" (owner) окно (если не указан экран)
РЕЗУЛЬТАТ
Открывается "скрытый" индикатор. Он будет отображаться в том
месте экрана,
в котором он был до "скрытия", если это возможно.
СМ. ТАКЖЕ
OpenProgressWindow(), HideProgressWindow()