15.3.3.2 Свойства окна

Свойства объектов figure (см. окно):

alphamap: def. 64-by-1 double

Прозрачность для объектов окна пока не реализована. alphamap не используется.

beingdeleted: {"off"} | "on"

busyaction: "cancel" | {"queue"}

Определяет, как Octave обрабатывает выполнение свойств обратного вызова этого объекта, когда он не может прервать выполнение обратного вызова другого объекта. Это актуально только в том случае, если объект, вызывающий обратный вызов в данный момент, имеет свойство interruptible установленное в значение "off". Свойство busyaction объекта, вызывающего прерывание, указывает, вызывается ли обратный вызов, вызывающий прерывание, в очереди ("queue" (по умолчанию)) или отбрасывается ("cancel"). См. раздел Обратные вызовы.

buttondownfcn: строка | функция, def. [](0x0)

Дополнительная информация о написании функций-листенере графики приведена в разделе Обратные вызовы.

children (только для чтения): вектор графических дескрипторов, def. [](0x1)

Графические дескрипторы дочерних элементов окна.

clipping: "off" | {"on"}

clipping не используется.

closerequestfcn: строка | функция, def. "closereq"

Функция, выполняемая при удалении окна. См. функцию closereq.

Дополнительная информация о написании функций-листенере графики приведена в разделе Обратные вызовы.

color: цветовое задание, def. [1 1 1]

Цвет фона окна. См. colorspec.

colormap: N-by-3 матрица, def. 64-by-3 double

Матрица, содержащая цветовую карту RGB для текущих осей.

contextmenu: графический дескриптор, def. [](0x0)

Графический дескриптор объекта контекстного меню uicontextmenu, который в настоящее время связан с этим объектом окна.

createfcn: строка | функция, def. [](0x0)

Функция обратного вызова, выполняемая сразу после создания окна. Функция устанавливается с помощью свойства по умолчанию для корневого объекта, например, set (groot, "defaultfigurecreatefcn", 'disp ("figure created!")').

Дополнительная информация о написании функций-листенере графики приведена в разделе Обратные вызовы.

currentaxes: графический дескриптор, def. [](0x0)

Дескриптор графического объекта текущих осей.

currentcharacter (только для чтения): def. ""

currentcharacter не используется.

currentobject (только для чтения): графический дескриптор, def. [](0x0)

currentpoint (только для чтения): двухэлементный вектор, def. [0; 0]

Матрица 1x2, которая хранит координаты точки, над которой находился указатель мыши при возникновении события мыши. Координаты X и Y заданы в единицах, определенных свойством units окна, и их началом является нижний левый угол области построения.

События, которые устанавливают currentpoint, следующие:

Нажата кнопка мыши

всегда

Кнопка мыши отпущена

только если определен обратный вызов окна windowbuttonupfcn

Указатель перемещен при нажатой кнопке мыши (перетаскивание)

только если определен обратный вызов окна windowbuttonmotionfcn

deletefcn: строка | функция, def. [](0x0)

Функция обратного вызова, выполняемая непосредственно перед удалением окна.

Дополнительная информация о написании функций-листенере графики приведена в разделе Обратные вызовы.

dockcontrols: {"off"} | "on"

dockcontrols не используется.

filename: строка, def. ""

Имя файла, используемого при сохранении графика.

graphicssmoothing: "off" | {"on"}

Используйте методы сглаживания для уменьшения видимости зубчатых линий.

handlevisibility: "callback" | "off" | {"on"}

Если handlevisibility имеет значение "off", дескриптор окна не отображается в свойстве "children" родительского элемента.

hittest: "off" | {"on"}

Указывает, обрабатывает ли окно события мыши или передает их родительским элементам. При включенном значении объект может реагировать на щелчки мыши, оценивая "buttondownfcn", отображая контекстное меню uicontextmenu и, в конечном итоге, становясь корневым элементом "currentobject". Это свойство актуально только в том случае, если объект может принимать щелчки мыши, что определяется свойством "pickableparts". См. свойство pickableparts.

integerhandle: "off" | {"on"}

Присваивает следующее наименьшее незанятое целое число в качестве номера окна.

interruptible: "off" | {"on"}

Указывает, могут ли функции обратного вызова этого объекта прерываться другими функциями обратного вызова. По умолчанию interruptible имеет значение "on", и обратные вызовы, использующие функции drawnow, figure, waitfor, getframe или pause, в конечном итоге прерываются. См. раздел Обратные вызовы.

inverthardcopy: "off" | {"on"}

Заменяет цвет фона окна и осей на белый при печати.

keypressfcn: строка | функция, def. [](0x0)

Функция обратного вызова, выполняемая при нажатии клавиши, когда окно имеет фокус. Фактическую нажатую клавишу можно получить, используя второй аргумент «evt» функции. Дополнительная информация о написании функций-листенере графики приведена в разделе Обратные вызовы.

keyreleasefcn: строка | функция, def. [](0x0)

С keypressfcn, функции обратного вызова клавиатуры. Эти функции вызываются при нажатии/отпускании клавиши соответственно. Функции вызываются с двумя входными аргументами. Первый аргумент содержит дескриптор вызываемого окна. Второй аргумент содержит структуру события, которая имеет следующие члены:

Character:

ASCII-значение клавиши

Key:

Значение клавиши в нижнем регистре

Modifier:

Массив ячеек, содержащий строки, представляющие нажатые модификаторы с клавишей.

Дополнительная информация о написании функций-листенере графики приведена в разделе Обратные вызовы.

menubar: {"figure"} | "none"

Управление отображением панели меню окна в верхней части окна.

name: строка, def. ""

Имя, отображаемое в строке заголовка окна. Имя отображается справа от любого заголовка, определенного свойством numbertitle.

nextplot: {"add"} | "new" | "replace" | "replacechildren"

nextplot используется функциями построения высокого уровня для определения действий с осями, уже присутствующими в окне. См. функцию newplot.

number (только для чтения):

numbertitle: "off" | {"on"}

Отображает "Окно" с последующим числовым значением дескриптора окна в строке заголовка окна.

outerposition: четырехэлементный вектор, def. [-1 -1 -1 -1]

Задает положение и размер окна, включая верхнюю панель меню и нижнюю строку состояния. Четыре элемента вектора — координаты нижнего левого угла и ширина и высота окна. См. свойство units.

paperorientation: "landscape" | {"portrait"}

Значение свойств papersize, и paperposition зависит от paperorientation. Горизонтальное и вертикальное значения для papersize и paperposition меняют порядок при переключении paperorientation между "portrait" и "landscape".

paperposition: четырехэлементный вектор, def. [1.3422 3.3191 5.8156 4.3617]

Вектор [left bottom width height], определяющий положение и размер окна (в paperunits единицах) на странице печати. Положение [left bottom] определяет нижний левый угол окна на странице, а размер определяется [width height]. Для форматов вывода, не отображаемых неявным образом на бумаге, width и height определяют размер изображения, а информация о положении игнорируется. Установка paperposition также принудительно устанавливает свойство paperpositionmode в "manual".

paperpositionmode: {"auto"} | "manual"

Если paperpositionmode установлено в "auto", свойство paperposition автоматически вычисляется: напечатанное окно будет иметь тот же размер, что и на экране, и будет центрировано на странице вывода. Установка paperpositionmode в "auto" не изменяет значение свойства paperposition.

papersize: двухэлементный вектор, def. [8.5000 11.0000]

Вектор [width height], определяющий размер бумаги для печати. Установка свойства papersize в значение, не связанное с одним из определенных papertypes и согласованное с настройкой paperorientation, принудительно устанавливает свойство papertype в значение "<custom>". Если papersize установлено в значение, связанное с поддерживаемым papertype и согласованное с paperorientation, значение papertype изменяется на соответствующее значение.

papertype: "<custom>" | "a" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "arch-a" | "arch-b" | "arch-c" | "arch-d" | "arch-e" | "b" | "b0" | "b1" | "b2" | "b3" | "b4" | "b5" | "c" | "d" | "e" | "tabloid" | "uslegal" | {"usletter"}

Имя бумаги, используемой для печатного вывода. Установка papertype также изменяет papersize, сохраняя при этом согласованность со свойством paperorientation.

paperunits: "centimeters" | {"inches"} | "normalized" | "points"

Единица, используемая для вычисления свойства paperposition. Преобразование из физических единиц (например, "inches") зависит от свойства screenpixelsperinch корневого объекта.

parent: дескриптор графического объекта, по умолчанию 0

Дескриптор родительского графического объекта.

pickableparts (только для чтения): "all" | "none" | {"visible"}

pickableparts не используется.

pointer: {"arrow"} | "botl" | "botr" | "bottom" | "circle" | "cross" | "crosshair" | "custom" | "fleur" | "hand" | "ibeam" | "left" | "right" | "top" | "topl" | "topr" | "watch"

Название формы указателя мыши, связанной с холстом фигуры. Когда pointer равно "custom", форма определяется свойством pointershapecdata.

pointer не имеет эффекта, когда фигура находится в режиме масштабирования, перемещения или поворота. В этом случае Octave автоматически использует форму указателя, соответствующую режиму.

pointershapecdata: 16x16 или 32x32 матрица, по умолчанию 16x16 double

m×m матрица, определяющая пользовательский указатель. Каждый элемент определяет пиксель, причём элемент (1,1) представляет левый верхний пиксель. Значение 1 окрашивает пиксель в чёрный цвет, 2 — в белый, а все остальные значения отображаются как прозрачные.

pointershapehotspot: вектор из двух элементов, по умолчанию [1 1]

Только для пользовательских указателей pointershapehotspot определяет строку и столбец пикселя в pointershapecdata, используемого в качестве положения указателя.

position: вектор из четырех элементов, по умолчанию [300 200 560 420]

Указывает положение и размер холста фигуры. Четыре элемента вектора — координаты левого нижнего угла и ширина и высота фигуры. См. свойство units.

renderer: {"opengl"} | "painters"

Движок отрисовки, используемый для печати, когда renderermode равно "manual". Установка renderer также принудительно устанавливает свойство renderermode в значение "manual".

renderermode: {"auto"} | "manual"

Управление тем, выбирается ли движок отрисовки для печати автоматически или задаётся свойством renderer. См. функцию print.

resize: "off" | {"on"}

Управление возможностью изменения размера фигуры перетаскиванием границ и углов окна мышью. Если resize равно "off", взаимодействия с мышью отключены, но фигуру всё ещё можно изменить размерами, изменив свойство "position".

resizefcn: строка | указатель на функцию, по умолчанию [](0x0)

resizefcn устарело. Используйте sizechangedfcn вместо него.

selected: {"off"} | "on"

selectionhighlight: "off" | {"on"}

selectiontype: "alt" | "extend" | {"normal"} | "open"

Тип выбора последнего щелчка мышью.

selectiontype может принимать разные значения в зависимости от комбинации нажатой кнопки мыши и модификаторов клавиатуры:

normal:

Нажатие левой кнопки мыши.

alt:

Нажатие правой кнопки мыши или Ctrl+Левая кнопка.

extend:

Нажатие Shift+Левая кнопка, Средняя кнопка или комбинация Левой и Правой кнопок.

open:

Двойное нажатие левой кнопки.

sizechangedfcn: строка | указатель на функцию, по умолчанию [](0x0)

Обработчик вызывается при изменении размера окна фигуры.

Подробнее о написании функций-обработчиков графических событий смотрите в разделе Обработчики событий.

tag: строка, по умолчанию ""

Пользовательская строка для маркировки графического объекта.

toolbar: {"auto"} | "figure" | "none"

Управление отображением панели инструментов (внизу строки меню) и строки состояния. При установке в "auto", отображение основано на значении свойства menubar.

type (только для чтения): строка

Имя класса графического объекта. type всегда "figure".

units: "centimeters" | "characters" | "inches" | "normalized" | {"pixels"} | "points"

Единица, используемая для вычисления свойств position и outerposition.

userdata: Любые данные Octave, по умолчанию [](0x0)

Пользовательские данные для ассоциации с графическим объектом.

visible: "off" | {"on"}

Если visible равно "off", фигура не отображается на экране.

windowbuttondownfcn: строка | указатель на функцию, по умолчанию [](0x0)

См. свойство windowbuttonupfcn.

windowbuttonmotionfcn: строка | указатель на функцию, по умолчанию [](0x0)

См. свойство windowbuttonupfcn.

windowbuttonupfcn: строка | указатель на функцию, по умолчанию [](0x0)

С windowbuttondownfcn и windowbuttonmotionfcn, функции обратного вызова мыши. Эти функции обратного вызова вызываются при нажатии, перетаскивании и отпускании кнопки мыши соответственно. При выполнении этих функций обратного вызова свойство currentpoint содержит текущие координаты курсора.

Подробнее о написании функций-обработчиков графических событий смотрите в разделе Обработчики событий.

windowkeypressfcn: строка | указатель на функцию, по умолчанию [](0x0)

Функция, выполняемая при нажатии клавиши и фокусе на фигуре.

Подробнее о написании функций-обработчиков графических событий смотрите в разделе Обработчики событий.

windowkeyreleasefcn: строка | указатель на функцию, по умолчанию [](0x0)

Функция, выполняемая при отпускании клавиши и фокусе на фигуре.

Подробнее о написании функций-обработчиков графических событий смотрите в разделе Обработчики событий.

windowscrollwheelfcn: строка | указатель на функцию, по умолчанию [](0x0)

Функция, выполняемая при взаимодействии пользователя с колесом мыши над этой фигурой. Функция вызывается с двумя входными аргументами. Первый аргумент содержит дескриптор вызываемой фигуры. Второй аргумент содержит структуру события, содержащую следующие члены:

VerticalScrollCount:

Количество шагов колеса, как правило, 1 при прокрутке вниз и -1 при прокрутке вверх.

VerticalScrollAmount:

Количество строк, на которое прокручивается шаг колеса. Это значение всегда равно 3.

EventName:

Имя события, которое равно "WindowScrollWheel".

Подробнее о написании функций-обработчиков графических событий смотрите в разделе Обработчики событий.

windowstyle: "docked" | "modal" | {"normal"}

Стиль окна фигуры. Одно из следующих значений:

normal

Установить стиль окна как немодальный.

modal

Установить окно как модальное, чтобы оно оставалось сверху всех обычных фигур.

docked

Установление стиля окна как привязанного в настоящее время не привязывает окно.

Изменение режимов видимой фигуры может привести к закрытию и повторному открытию фигуры.