@c DO NOT EDIT!  Generated automatically by genpropdoc.m.

@c Copyright (C) 2014-2025 The Octave Project Developers
@c
@c See the file COPYRIGHT.md in the top-level directory of this
@c distribution or <https://octave.org/copyright/>.
@c
@c This file is part of Octave.
@c
@c Octave is free software: you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by
@c the Free Software Foundation, either version 3 of the License, or
@c (at your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but
@c WITHOUT ANY WARRANTY; without even the implied warranty of
@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@c GNU General Public License for more details.
@c
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <https://www.gnu.org/licenses/>.

Properties of the root graphics object:

@subsubheading Categories:

@ref{XREFrootcategoryCallbackExecution, , @w{Callback Execution}}@: | @ref{XREFrootcategoryCommandWindowDisplay, , @w{Command Window Display}}@: | @ref{XREFrootcategoryMouseInteraction, , @w{Mouse Interaction}}@: | @ref{XREFrootcategoryObjectIdentification, , @w{Object Identification}}@: | @ref{XREFrootcategoryParent/Children, , @w{Parent/Children}}@: | @ref{XREFrootcategoryPointerInformation, , @w{Pointer Information}}@: | @ref{XREFrootcategoryScreenInformation, , @w{Screen Information}}@: | @ref{XREFrootcategoryUnused, , @w{Unused}}@: 

@anchor{XREFrootcategoryCallbackExecution}
@subsubheading Callback Execution

@table @asis

@anchor{XREFrootcallbackobject}
@prindex root callbackobject
@item @code{callbackobject} (read-only): graphics handle, def. @code{[](0x0)}
Graphics handle of the current object whose callback is executing.

@end table

@anchor{XREFrootcategoryCommandWindowDisplay}
@subsubheading Command Window Display

@table @asis

@anchor{XREFrootcommandwindowsize}
@prindex root commandwindowsize
@item @code{commandwindowsize} (read-only): two-element vector, def. @code{[0   0]}
The number of columns and rows displayed in a newly created command window.


@anchor{XREFrootfixedwidthfontname}
@prindex root fixedwidthfontname
@item @code{fixedwidthfontname}: string, def. @qcode{"Courier"}
Name of the fixed-width font that will be used for graphics objects when the @qcode{"fontname"} property is set to @qcode{"FixedWidth"}.

@end table

@anchor{XREFrootcategoryMouseInteraction}
@subsubheading Mouse Interaction

@table @asis

@anchor{XREFrootcontextmenu}
@prindex root contextmenu
@item @code{contextmenu}: graphics handle, def. @code{[](0x0)}
Graphics handle of the uicontextmenu object that is currently associated to this root object.

@end table

@anchor{XREFrootcategoryObjectIdentification}
@subsubheading Object Identification

@table @asis

@anchor{XREFrootcurrentfigure}
@prindex root currentfigure
@item @code{currentfigure}: graphics handle, def. @code{[](0x0)}
Graphics handle of the current figure.


@anchor{XREFroottag}
@prindex root tag
@item @code{tag}: string, def. @qcode{""}
A user-defined string to label the graphics object.


@anchor{XREFroottype}
@prindex root type
@item @code{type} (read-only): string
Class name of the graphics object.  @code{type} is always @qcode{"root"}.


@anchor{XREFrootuserdata}
@prindex root userdata
@item @code{userdata}: Any Octave data, def. @code{[](0x0)}
User-defined data to associate with the graphics object.

@end table

@anchor{XREFrootcategoryParent/Children}
@subsubheading Parent/Children

@table @asis

@anchor{XREFrootchildren}
@prindex root children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
Graphics handles of the root's children.


@anchor{XREFroothandlevisibility}
@prindex root handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
The root object handle is always visible.  Changing this setting to @qcode{"callback"} or @qcode{"off"} has no effect.


@anchor{XREFrootparent}
@prindex root parent
@item @code{parent}: graphics handle, def. @code{[](0x0)}
Root object has no parent graphics object.  @code{parent} is always empty.


@anchor{XREFrootshowhiddenhandles}
@prindex root showhiddenhandles
@item @code{showhiddenhandles}: @{@qcode{"off"}@} | @qcode{"on"}
If @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.

@end table

@anchor{XREFrootcategoryPointerInformation}
@subsubheading Pointer Information

@table @asis

@anchor{XREFrootpointerlocation}
@prindex root pointerlocation
@item @code{pointerlocation}: two-element vector, def. @code{[0   0]}
Global pointer location         tracking is not yet implemented for root objects.  @code{pointerlocation} is unused.  @code{pointerlocation} for root objects will always be         [0 0].


@anchor{XREFrootpointerwindow}
@prindex root pointerwindow
@item @code{pointerwindow} (read-only): graphics handle, def. @code{0}
Pointer window tracking is not yet implemented for root objects.  @code{pointerwindow} is unused.  @code{pointerwindow} value for root objects will always be 0.

@end table

@anchor{XREFrootcategoryScreenInformation}
@subsubheading Screen Information

@table @asis

@anchor{XREFrootmonitorpositions}
@prindex root monitorpositions
@item @code{monitorpositions} (read-only): four-element vector
Reports the width and height of connected monitors.  Note: Octave only partially implements @code{monitorpositions}.  Only information about the primary monitor is stored in @code{monitorpositions} which is the same information stored in the @ref{XREFrootscreensize, , @w{@qcode{"screensize"} property}}.


@anchor{XREFrootscreendepth}
@prindex root screendepth
@item @code{screendepth} (read-only): double
Color depth in bits per pixel of the display.


@anchor{XREFrootscreenpixelsperinch}
@prindex root screenpixelsperinch
@item @code{screenpixelsperinch} (read-only): double
The screen resolution of the primary display in units of pixels per inch.


@anchor{XREFrootscreensize}
@prindex root screensize
@item @code{screensize} (read-only): four-element vector
Size of the primary display represented as the four-element vector [left, bottom, width, height].


@anchor{XREFrootunits}
@prindex root units
@item @code{units}: @qcode{"centimeters"} | @qcode{"characters"} | @qcode{"inches"} | @qcode{"normalized"} | @{@qcode{"pixels"}@} | @qcode{"points"}
The unit type used for the @ref{XREFrootmonitorpositions, , @qcode{"monitorpositions"}}, @ref{XREFrootpointerlocation, , @qcode{"pointerlocation"}}, and @ref{XREFrootscreensize, , @qcode{"screensize"}} properties.

@end table

@anchor{XREFrootcategoryUnused}
@subsubheading Unused

@table @asis

@anchor{XREFrootbeingdeleted}
@prindex root beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}
@code{beingdeleted} is unused.


@anchor{XREFrootbusyaction}
@prindex root busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}
@code{busyaction} is unused.


@anchor{XREFrootbuttondownfcn}
@prindex root buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}
@code{buttondownfcn} is unused.


@anchor{XREFrootclipping}
@prindex root clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
@code{clipping} is unused.


@anchor{XREFrootcreatefcn}
@prindex root createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
@code{createfcn} is unused.


@anchor{XREFrootdeletefcn}
@prindex root deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
@code{deletefcn} is unused.


@anchor{XREFroothittest}
@prindex root hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}
@code{hittest} is unused.


@anchor{XREFrootinterruptible}
@prindex root interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}
@code{interruptible} is unused.


@anchor{XREFrootpickableparts}
@prindex root pickableparts
@item @code{pickableparts}: @qcode{"all"} | @qcode{"none"} | @{@qcode{"visible"}@}
@code{pickableparts} is unused.


@anchor{XREFrootselected}
@prindex root selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}
@code{selected} is unused.


@anchor{XREFrootselectionhighlight}
@prindex root selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}
@code{selectionhighlight} is unused.


@anchor{XREFrootvisible}
@prindex root visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
@code{visible} is unused.

@end table