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

@c Copyright (C) 2014-2016 Pantxo Diribarne
@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 the
@c Free Software Foundation; either version 3 of the License, or (at
@c your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@c FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
@c 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 <http://www.gnu.org/licenses/>.

@table @asis

@anchor{XREFtext__modified__}
@cindex text __modified__
@item @code{__modified__}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtextbackgroundcolor}
@cindex text backgroundcolor
@item @code{backgroundcolor}: colorspec, def. @qcode{"none"}
Background area is not yet implemented for text objects.  @code{backgroundcolor} is unused.


@anchor{XREFtextbeingdeleted}
@cindex text beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFtextbusyaction}
@cindex text busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}



@anchor{XREFtextbuttondownfcn}
@cindex text buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}
For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFtextchildren}
@cindex text children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
@code{children} is unused.


@anchor{XREFtextclipping}
@cindex text clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{clipping} is @qcode{"on"}, the text is clipped in its parent axes limits.


@anchor{XREFtextcolor}
@cindex text color
@item @code{color}: colorspec, def. @code{[0   0   0]}
Color of the text.  @xref{Colors, ,colorspec}.


@anchor{XREFtextcreatefcn}
@cindex text createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately after text has been created.  Function is set by using default property on root object, e.g., @code{set (0, "defaulttextcreatefcn", 'disp ("text created!")')}.

For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFtextdeletefcn}
@cindex text deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately before text is deleted.

For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFtextdisplayname}
@cindex text displayname
@item @code{displayname}: def. @qcode{""}



@anchor{XREFtextedgecolor}
@cindex text edgecolor
@item @code{edgecolor}: colorspec, def. @qcode{"none"}
Background area is not yet implemented for text objects.  @code{edgecolor} is unused.


@anchor{XREFtextediting}
@cindex text editing
@item @code{editing}: @{@qcode{"off"}@} | @qcode{"on"}
@code{editing} is unused.


@anchor{XREFtextextent}
@cindex text extent
@item @code{extent} (read-only): four-element vector, def. @code{[0.000000  -0.008764   0.000000   0.037978]}
Vector @code{[x0 y0 width height]} indicating the size and location of the text string.


@anchor{XREFtextfontangle}
@cindex text fontangle
@item @code{fontangle}: @qcode{"italic"} | @{@qcode{"normal"}@} | @qcode{"oblique"}
Control whether the font is italic or normal.  @code{fontangle} is currently unused.


@anchor{XREFtextfontname}
@cindex text fontname
@item @code{fontname}: string, def. @qcode{"*"}
The font used for the text.


@anchor{XREFtextfontsize}
@cindex text fontsize
@item @code{fontsize}: scalar, def. @code{10}
The font size of the text as measured in @code{fontunits}.


@anchor{XREFtextfontunits}
@cindex text fontunits
@item @code{fontunits}: @qcode{"centimeters"} | @qcode{"inches"} | @qcode{"normalized"} | @qcode{"pixels"} | @{@qcode{"points"}@}
The units used to interpret @code{fontsize} property.


@anchor{XREFtextfontweight}
@cindex text fontweight
@item @code{fontweight}: @qcode{"bold"} | @qcode{"demi"} | @qcode{"light"} | @{@qcode{"normal"}@}
Control variant of base font used: bold, light, normal, etc.


@anchor{XREFtexthandlevisibility}
@cindex text handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
If @code{handlevisibility} is @qcode{"off"}, the text's handle is not visible in its parent's "children" property.


@anchor{XREFtexthittest}
@cindex text hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtexthorizontalalignment}
@cindex text horizontalalignment
@item @code{horizontalalignment}: @qcode{"center"} | @{@qcode{"left"}@} | @qcode{"right"}



@anchor{XREFtextinterpreter}
@cindex text interpreter
@item @code{interpreter}: @qcode{"latex"} | @qcode{"none"} | @{@qcode{"tex"}@}
Control the way the @qcode{"string"} property is interpreted.
@xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.


@anchor{XREFtextinterruptible}
@cindex text interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtextlinestyle}
@cindex text linestyle
@item @code{linestyle}: @{@qcode{"-"}@} | @qcode{"--"} | @qcode{"-."} | @qcode{":"} | @qcode{"none"}
Background area is not yet implemented for text objects.  @code{linestyle} is unused.


@anchor{XREFtextlinewidth}
@cindex text linewidth
@item @code{linewidth}: scalar, def. @code{0.50000}
Background area is not yet implemented for text objects.  @code{linewidth} is unused.


@anchor{XREFtextmargin}
@cindex text margin
@item @code{margin}: scalar, def. @code{2}
Background area is not yet implemented for text objects.  @code{margin} is unused.


@anchor{XREFtextparent}
@cindex text parent
@item @code{parent}: graphics handle
Handle of the parent graphics object.


@anchor{XREFtextposition}
@cindex text position
@item @code{position}: four-element vector, def. @code{[0   0   0]}
Vector @code{[X0 Y0 Z0]} where X0, Y0 and Z0 indicate the position of the text anchor as defined by @code{verticalalignment} and @code{horizontalalignment}.


@anchor{XREFtextrotation}
@cindex text rotation
@item @code{rotation}: scalar, def. @code{0}
The angle of rotation for the displayed text, measured in degrees.


@anchor{XREFtextselected}
@cindex text selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFtextselectionhighlight}
@cindex text selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtextstring}
@cindex text string
@item @code{string}: string, def. @qcode{""}
The text object string content.


@anchor{XREFtexttag}
@cindex text tag
@item @code{tag}: string, def. @qcode{""}
A user-defined string to label the graphics object.


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


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


@anchor{XREFtextunits}
@cindex text units
@item @code{units}: @qcode{"centimeters"} | @{@qcode{"data"}@} | @qcode{"inches"} | @qcode{"normalized"} | @qcode{"pixels"} | @qcode{"points"}



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


@anchor{XREFtextverticalalignment}
@cindex text verticalalignment
@item @code{verticalalignment}: @qcode{"baseline"} | @qcode{"bottom"} | @qcode{"cap"} | @{@qcode{"middle"}@} | @qcode{"top"}



@anchor{XREFtextvisible}
@cindex text visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{visible} is @qcode{"off"}, the text is not rendered on screen.

@end table