15.4.4 Обратные вызовы

Обратные вызовы могут быть связаны с графическими объектами и вызываются после возникновения определенных событий. Основная структура всех обратных функций:

function mycallback (hsrc, evt)
  …
endfunction

где hsrc — указатель на источник обратного вызова, и evt содержит данные, специфичные для события.

Функцию можно предоставить как указатель на обычную функцию Octave, как анонимную функцию или как строку, представляющую команду Octave. Последний синтаксис не рекомендуется, так как ошибки синтаксиса возникнут только при вычислении строки. См. раздел "Указатели на функции и анонимные функции".

Это можно связать с объектом либо при его создании, либо позже с помощью функции set. Например,

plot (x, "DeleteFcn", @(h, e) disp ("Window Deleted"))

где в момент удаления графика будет отображено сообщение "Window Deleted".

Дополнительные пользовательские аргументы могут быть переданы в обратные вызовы и будут переданы после двух стандартных аргументов. Например:

plot (x, "DeleteFcn", {@mycallback, "1"})
…
function mycallback (h, evt, arg1)
  fprintf ("Closing plot %d\n", arg1);
endfunction

Внимание: Второй аргумент в обратных вызовах — evt — частично реализован в графическом интерфейсе Qt:

• События нажатия мыши: evt — значение класса double: 1 для левой, 2 для средней и 3 для правой кнопки.
• События нажатия клавиши: evt — структура с полями Key (строка), Character (строка) и Modifier (массив строк).
• Другие события: evt — значение класса double пустая матрица.

Основные обратные вызовы, доступные для всех графических объектов, это

• CreateFcn: вызывается в момент создания объекта. Он не вызывается, если объект каким-либо образом изменяется, поэтому имеет смысл определить этот обратный вызов в вызове функции, определяющей объект. Обратные вызовы, добавленные к CreateFcn позже с помощью функции set никогда не будут выполнены.
• DeleteFcn: вызывается в момент удаления объекта.
• ButtonDownFcn: вызывается, если нажата кнопка мыши, пока указатель находится над этим объектом. Обратите внимание, что интерфейс gnuplot не реализует этот обратный вызов.

По умолчанию, обратные вызовы помещаются в очередь (они выполняются один за другим в очереди событий), если не используются функции drawnow, figure, waitfor, getframe, или pause. Если выполняемый обратный вызов вызывает одну из этих функций, это приводит к очистке очереди событий Octave, что приводит к прерыванию выполняемого обратного вызова.

Можно указать, что обратные вызовы объекта не должны прерываться, установив свойство объекта interruptible в "off". В этом случае Octave решает, что делать, на основе свойства busyaction объекта вызывающего обратного вызова:

queue (по умолчанию)

Вызываемый обратный вызов выполняется после возвращения выполняющегося обратного вызова.

cancel

Вызываемый обратный вызов отбрасывается.

Свойство interruptible не оказывает влияния, когда вызывающий обратный вызов является deletefcn, или фигурой resizefcn или closerequestfcn. Эти обратные вызовы всегда прерывают выполняющийся обратный вызов.

Указатель на объект, содержащий выполняемый обратный вызов, можно получить с помощью функции gcbo. Указатель на родительскую фигуру этого объекта можно получить с помощью функции gcbf.

: h = gcbo () ¶

: [h, fig] = gcbo () ¶

Возвращает указатель на объект, обратный вызов которого выполняется в данный момент.

Если обратный вызов не выполняется, эта функция возвращает пустую матрицу. Этот указатель получается из свойства корневого объекта "CallbackObject".

При вызове со вторым выходным аргументом, возвращает указатель на фигуру, содержащую объект, обратный вызов которого выполняется в данный момент. Если обратный вызов не выполняется, второй выходной аргумент также устанавливается в пустую матрицу.

См. также: gcbf, gco, gca, gcf, get, set.

: fig = gcbf () ¶

Возвращает указатель на фигуру, содержащую объект, обратный вызов которого выполняется в данный момент.

Если обратный вызов не выполняется, эта функция возвращает пустую матрицу. Указатель, возвращаемый этой функцией, такой же, как второй выходной аргумент функции gcbo.

См. также: gcbo, gcf, gco, gca, get, set.

Обратные вызовы также могут быть добавлены к свойствам с помощью функции addlistener описанной ниже.