/usr/share/doc/octave/octave.html/Text-Properties.html is in octave-doc 4.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Text Properties (GNU Octave)</title>
<meta name="description" content="Text Properties (GNU Octave)">
<meta name="keywords" content="Text Properties (GNU Octave)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html#Graphics-Object-Properties" rel="up" title="Graphics Object Properties">
<link href="Image-Properties.html#Image-Properties" rel="next" title="Image Properties">
<link href="Line-Properties.html#Line-Properties" rel="prev" title="Line Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<a name="Text-Properties"></a>
<div class="header">
<p>
Next: <a href="Image-Properties.html#Image-Properties" accesskey="n" rel="next">Image Properties</a>, Previous: <a href="Line-Properties.html#Line-Properties" accesskey="p" rel="prev">Line Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" accesskey="u" rel="up">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Text-Properties-1"></a>
<h4 class="subsubsection">15.3.3.5 Text Properties</h4>
<a name="index-text-properties"></a>
<p>The <code>text</code> properties are:
</p>
<dl compact="compact">
<dd>
<a name="XREFtext_005f_005fmodified_005f_005f"></a><a name="index-text-_005f_005fmodified_005f_005f"></a>
</dd>
<dt><code>__modified__</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFtextbackgroundcolor"></a><a name="index-text-backgroundcolor"></a>
</dd>
<dt><code>backgroundcolor</code>: colorspec, def. <code>"none"</code></dt>
<dd><p>Background area is not yet implemented for text objects. <code>backgroundcolor</code> is unused.
</p>
<a name="XREFtextbeingdeleted"></a><a name="index-text-beingdeleted"></a>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFtextbusyaction"></a><a name="index-text-busyaction"></a>
</dd>
<dt><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</dt>
<dd>
<a name="XREFtextbuttondownfcn"></a><a name="index-text-buttondownfcn"></a>
</dd>
<dt><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFtextchildren"></a><a name="index-text-children"></a>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p><code>children</code> is unused.
</p>
<a name="XREFtextclipping"></a><a name="index-text-clipping"></a>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>clipping</code> is <code>"on"</code>, the text is clipped in its parent axes limits.
</p>
<a name="XREFtextcolor"></a><a name="index-text-color"></a>
</dd>
<dt><code>color</code>: colorspec, def. <code>[0 0 0]</code></dt>
<dd><p>Color of the text. See <a href="Colors.html#Colors">colorspec</a>.
</p>
<a name="XREFtextcreatefcn"></a><a name="index-text-createfcn"></a>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>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!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFtextdeletefcn"></a><a name="index-text-deletefcn"></a>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before text is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFtextdisplayname"></a><a name="index-text-displayname"></a>
</dd>
<dt><code>displayname</code>: def. <code>""</code></dt>
<dd>
<a name="XREFtextedgecolor"></a><a name="index-text-edgecolor"></a>
</dd>
<dt><code>edgecolor</code>: colorspec, def. <code>"none"</code></dt>
<dd><p>Background area is not yet implemented for text objects. <code>edgecolor</code> is unused.
</p>
<a name="XREFtextediting"></a><a name="index-text-editing"></a>
</dd>
<dt><code>editing</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd><p><code>editing</code> is unused.
</p>
<a name="XREFtextextent"></a><a name="index-text-extent"></a>
</dd>
<dt><code>extent</code> (read-only): four-element vector, def. <code>[0.000000 -0.008764 0.000000 0.037978]</code></dt>
<dd><p>Vector <code>[x0 y0 width height]</code> indicating the size and location of the text string.
</p>
<a name="XREFtextfontangle"></a><a name="index-text-fontangle"></a>
</dd>
<dt><code>fontangle</code>: <code>"italic"</code> | {<code>"normal"</code>} | <code>"oblique"</code></dt>
<dd><p>Control whether the font is italic or normal. <code>fontangle</code> is currently unused.
</p>
<a name="XREFtextfontname"></a><a name="index-text-fontname"></a>
</dd>
<dt><code>fontname</code>: string, def. <code>"*"</code></dt>
<dd><p>The font used for the text.
</p>
<a name="XREFtextfontsize"></a><a name="index-text-fontsize"></a>
</dd>
<dt><code>fontsize</code>: scalar, def. <code>10</code></dt>
<dd><p>The font size of the text as measured in <code>fontunits</code>.
</p>
<a name="XREFtextfontunits"></a><a name="index-text-fontunits"></a>
</dd>
<dt><code>fontunits</code>: <code>"centimeters"</code> | <code>"inches"</code> | <code>"normalized"</code> | <code>"pixels"</code> | {<code>"points"</code>}</dt>
<dd><p>The units used to interpret <code>fontsize</code> property.
</p>
<a name="XREFtextfontweight"></a><a name="index-text-fontweight"></a>
</dd>
<dt><code>fontweight</code>: <code>"bold"</code> | <code>"demi"</code> | <code>"light"</code> | {<code>"normal"</code>}</dt>
<dd><p>Control variant of base font used: bold, light, normal, etc.
</p>
<a name="XREFtexthandlevisibility"></a><a name="index-text-handlevisibility"></a>
</dd>
<dt><code>handlevisibility</code>: <code>"callback"</code> | <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>handlevisibility</code> is <code>"off"</code>, the text’s handle is not visible in its parent’s "children" property.
</p>
<a name="XREFtexthittest"></a><a name="index-text-hittest"></a>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFtexthorizontalalignment"></a><a name="index-text-horizontalalignment"></a>
</dd>
<dt><code>horizontalalignment</code>: <code>"center"</code> | {<code>"left"</code>} | <code>"right"</code></dt>
<dd>
<a name="XREFtextinterpreter"></a><a name="index-text-interpreter"></a>
</dd>
<dt><code>interpreter</code>: <code>"latex"</code> | <code>"none"</code> | {<code>"tex"</code>}</dt>
<dd><p>Control the way the <code>"string"</code> property is interpreted.
See <a href="Use-of-the-interpreter-Property.html#XREFinterpreterusage">Use of the interpreter property<!-- /@w --></a>.
</p>
<a name="XREFtextinterruptible"></a><a name="index-text-interruptible"></a>
</dd>
<dt><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFtextlinestyle"></a><a name="index-text-linestyle"></a>
</dd>
<dt><code>linestyle</code>: {<code>"-"</code>} | <code>"--"</code> | <code>"-."</code> | <code>":"</code> | <code>"none"</code></dt>
<dd><p>Background area is not yet implemented for text objects. <code>linestyle</code> is unused.
</p>
<a name="XREFtextlinewidth"></a><a name="index-text-linewidth"></a>
</dd>
<dt><code>linewidth</code>: scalar, def. <code>0.50000</code></dt>
<dd><p>Background area is not yet implemented for text objects. <code>linewidth</code> is unused.
</p>
<a name="XREFtextmargin"></a><a name="index-text-margin"></a>
</dd>
<dt><code>margin</code>: scalar, def. <code>2</code></dt>
<dd><p>Background area is not yet implemented for text objects. <code>margin</code> is unused.
</p>
<a name="XREFtextparent"></a><a name="index-text-parent"></a>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<a name="XREFtextposition"></a><a name="index-text-position"></a>
</dd>
<dt><code>position</code>: four-element vector, def. <code>[0 0 0]</code></dt>
<dd><p>Vector <code>[X0 Y0 Z0]</code> where X0, Y0 and Z0 indicate the position of the text anchor as defined by <code>verticalalignment</code> and <code>horizontalalignment</code>.
</p>
<a name="XREFtextrotation"></a><a name="index-text-rotation"></a>
</dd>
<dt><code>rotation</code>: scalar, def. <code>0</code></dt>
<dd><p>The angle of rotation for the displayed text, measured in degrees.
</p>
<a name="XREFtextselected"></a><a name="index-text-selected"></a>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFtextselectionhighlight"></a><a name="index-text-selectionhighlight"></a>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFtextstring"></a><a name="index-text-string"></a>
</dd>
<dt><code>string</code>: string, def. <code>""</code></dt>
<dd><p>The text object string content.
</p>
<a name="XREFtexttag"></a><a name="index-text-tag"></a>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a name="XREFtexttype"></a><a name="index-text-type"></a>
</dd>
<dt><code>type</code> (read-only): string</dt>
<dd><p>Class name of the graphics object. <code>type</code> is always <code>"text"</code>
</p>
<a name="XREFtextuicontextmenu"></a><a name="index-text-uicontextmenu"></a>
</dd>
<dt><code>uicontextmenu</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this text object.
</p>
<a name="XREFtextunits"></a><a name="index-text-units"></a>
</dd>
<dt><code>units</code>: <code>"centimeters"</code> | {<code>"data"</code>} | <code>"inches"</code> | <code>"normalized"</code> | <code>"pixels"</code> | <code>"points"</code></dt>
<dd>
<a name="XREFtextuserdata"></a><a name="index-text-userdata"></a>
</dd>
<dt><code>userdata</code>: Any Octave data, def. <code>[](0x0)</code></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
<a name="XREFtextverticalalignment"></a><a name="index-text-verticalalignment"></a>
</dd>
<dt><code>verticalalignment</code>: <code>"baseline"</code> | <code>"bottom"</code> | <code>"cap"</code> | {<code>"middle"</code>} | <code>"top"</code></dt>
<dd>
<a name="XREFtextvisible"></a><a name="index-text-visible"></a>
</dd>
<dt><code>visible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>visible</code> is <code>"off"</code>, the text is not rendered on screen.
</p>
</dd>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Image-Properties.html#Image-Properties" accesskey="n" rel="next">Image Properties</a>, Previous: <a href="Line-Properties.html#Line-Properties" accesskey="p" rel="prev">Line Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" accesskey="u" rel="up">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|