1@c DO NOT EDIT! Generated automatically by genpropdoc.m. 2 3@c Copyright (C) 2014-2019 Pantxo Diribarne 4@c 5@c This file is part of Octave. 6@c 7@c Octave is free software: you can redistribute it and/or modify it 8@c under the terms of the GNU General Public License as published by 9@c the Free Software Foundation, either version 3 of the License, or 10@c (at your option) any later version. 11@c 12@c Octave is distributed in the hope that it will be useful, but 13@c WITHOUT ANY WARRANTY; without even the implied warranty of 14@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15@c GNU General Public License for more details. 16@c 17@c You should have received a copy of the GNU General Public License 18@c along with Octave; see the file COPYING. If not, see 19@c <https://www.gnu.org/licenses/>. 20 21Properties of the root graphics object: 22 23@table @asis 24 25@anchor{XREFrootbeingdeleted} 26@prindex root beingdeleted 27@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"} 28@code{beingdeleted} is unused. 29 30 31@anchor{XREFrootbusyaction} 32@prindex root busyaction 33@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@} 34@code{busyaction} is unused. 35 36 37@anchor{XREFrootbuttondownfcn} 38@prindex root buttondownfcn 39@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)} 40@code{buttondownfcn} is unused. 41 42 43@anchor{XREFrootcallbackobject} 44@prindex root callbackobject 45@item @code{callbackobject} (read-only): graphics handle, def. @code{[](0x0)} 46Graphics handle of the current object whose callback is executing. 47 48 49@anchor{XREFrootchildren} 50@prindex root children 51@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)} 52Graphics handles of the root's children. 53 54 55@anchor{XREFrootclipping} 56@prindex root clipping 57@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@} 58@code{clipping} is unused. 59 60 61@anchor{XREFrootcommandwindowsize} 62@prindex root commandwindowsize 63@item @code{commandwindowsize} (read-only): def. @code{[0 0]} 64 65 66 67@anchor{XREFrootcreatefcn} 68@prindex root createfcn 69@item @code{createfcn}: string | function handle, def. @code{[](0x0)} 70@code{createfcn} is unused. 71 72 73@anchor{XREFrootcurrentfigure} 74@prindex root currentfigure 75@item @code{currentfigure}: graphics handle, def. @code{[](0x0)} 76Graphics handle of the current figure. 77 78 79@anchor{XREFrootdeletefcn} 80@prindex root deletefcn 81@item @code{deletefcn}: string | function handle, def. @code{[](0x0)} 82@code{deletefcn} is unused. 83 84 85@anchor{XREFrootfixedwidthfontname} 86@prindex root fixedwidthfontname 87@item @code{fixedwidthfontname}: string, def. @qcode{"Courier"} 88 89 90 91@anchor{XREFroothandlevisibility} 92@prindex root handlevisibility 93@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@} 94@code{handlevisibility} is unused. 95 96 97@anchor{XREFroothittest} 98@prindex root hittest 99@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@} 100@code{hittest} is unused. 101 102 103@anchor{XREFrootinterruptible} 104@prindex root interruptible 105@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@} 106@code{interruptible} is unused. 107 108 109@anchor{XREFrootmonitorpositions} 110@prindex root monitorpositions 111@item @code{monitorpositions} (read-only): 112@code{monitorpositions} is unused. 113 114 115@anchor{XREFrootparent} 116@prindex root parent 117@item @code{parent}: graphics handle, def. @code{[](0x0)} 118Root object has no parent graphics object. @code{parent} is always empty. 119 120 121@anchor{XREFrootpickableparts} 122@prindex root pickableparts 123@item @code{pickableparts}: @qcode{"all"} | @qcode{"none"} | @{@qcode{"visible"}@} 124@code{pickableparts} is unused. 125 126 127@anchor{XREFrootpointerlocation} 128@prindex root pointerlocation 129@item @code{pointerlocation}: two-element vector, def. @code{[0 0]} 130@code{pointerlocation} is unused. 131 132 133@anchor{XREFrootpointerwindow} 134@prindex root pointerwindow 135@item @code{pointerwindow} (read-only): graphics handle, def. @code{0} 136@code{pointerwindow} is unused. 137 138 139@anchor{XREFrootscreendepth} 140@prindex root screendepth 141@item @code{screendepth} (read-only): double 142 143 144 145@anchor{XREFrootscreenpixelsperinch} 146@prindex root screenpixelsperinch 147@item @code{screenpixelsperinch} (read-only): double 148 149 150 151@anchor{XREFrootscreensize} 152@prindex root screensize 153@item @code{screensize} (read-only): four-element vector 154 155 156 157@anchor{XREFrootselected} 158@prindex root selected 159@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"} 160@code{selected} is unused. 161 162 163@anchor{XREFrootselectionhighlight} 164@prindex root selectionhighlight 165@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@} 166@code{selectionhighlight} is unused. 167 168 169@anchor{XREFrootshowhiddenhandles} 170@prindex root showhiddenhandles 171@item @code{showhiddenhandles}: @{@qcode{"off"}@} | @qcode{"on"} 172If @code{showhiddenhandles} is @qcode{"on"}, all graphics objects handles are visible in their parents' children list, regardless of the value of their @code{handlevisibility} property. 173 174 175@anchor{XREFroottag} 176@prindex root tag 177@item @code{tag}: string, def. @qcode{""} 178A user-defined string to label the graphics object. 179 180 181@anchor{XREFroottype} 182@prindex root type 183@item @code{type} (read-only): string 184Class name of the graphics object. @code{type} is always @qcode{"root"} 185 186 187@anchor{XREFrootuicontextmenu} 188@prindex root uicontextmenu 189@item @code{uicontextmenu}: graphics handle, def. @code{[](0x0)} 190@code{uicontextmenu} is unused. 191 192 193@anchor{XREFrootunits} 194@prindex root units 195@item @code{units}: @qcode{"centimeters"} | @qcode{"characters"} | @qcode{"inches"} | @qcode{"normalized"} | @{@qcode{"pixels"}@} | @qcode{"points"} 196 197 198 199@anchor{XREFrootuserdata} 200@prindex root userdata 201@item @code{userdata}: Any Octave data, def. @code{[](0x0)} 202User-defined data to associate with the graphics object. 203 204 205@anchor{XREFrootvisible} 206@prindex root visible 207@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@} 208@code{visible} is unused. 209 210@end table