comparison doc/interpreter/plot.txi @ 20628:3af34e1ef330

Preliminary inclusion of uixx objects properties in the manual (bug #46076) * doc/interpreter/genpropdoc.m: add uixx objects to the list of supported graphics objects * doc/interpreter/genpropdoc.m (get_doc): add uixx objects and their specific properties (currently empty documentation) * doc/interpreter/plot.txi("Interacting with Plots"): add a note and a reference about ui* family of functions. * doc/interpreter/plot.txi("Interacting with Plots"): for consistency, remove "uimenu" reference. All the other uixx are already in the gui section * doc/interpreter/plot.txi("graphics data structure"): add uixx objects * doc/interpreter/gui.txi("UI Elements"): add "uimenu" function reference * doc/module.mk: add rules to build uixx properties texi files. * graphics.in.h: make uixx "__object__" property (Octave internal) hidden so that it does not appear in the documentation.
author Pantxo Diribarne <pantxo.diribarne@gmail.com>
date Fri, 09 Oct 2015 16:25:27 +0200
parents 031e76c51242
children
comparison
equal deleted inserted replaced
20627:56333f6df823 20628:3af34e1ef330
1001 1001
1002 @node Interacting with Plots 1002 @node Interacting with Plots
1003 @subsection Interacting with Plots 1003 @subsection Interacting with Plots
1004 1004
1005 The user can select points on a plot with the @code{ginput} function or 1005 The user can select points on a plot with the @code{ginput} function or
1006 selection the position at which to place text on the plot with the 1006 select the position at which to place text on the plot with the
1007 @code{gtext} function using the mouse. Menus may also be created 1007 @code{gtext} function using the mouse.
1008 and populated with specific user commands via the @code{uimenu} function.
1009 1008
1010 @DOCSTRING(ginput) 1009 @DOCSTRING(ginput)
1011 1010
1012 @DOCSTRING(waitforbuttonpress) 1011 @DOCSTRING(waitforbuttonpress)
1013 1012
1014 @DOCSTRING(gtext) 1013 @DOCSTRING(gtext)
1015 1014
1016 @DOCSTRING(uimenu) 1015 More sophisticated user interaction mechanisms can be obtained using the ui*
1016 family of functions, @pxref{UI Elements}.
1017 1017
1018 @node Test Plotting Functions 1018 @node Test Plotting Functions
1019 @subsection Test Plotting Functions 1019 @subsection Test Plotting Functions
1020 1020
1021 The functions @code{sombrero} and @code{peaks} provide a way to check 1021 The functions @code{sombrero} and @code{peaks} provide a way to check
1368 * Line Properties:: 1368 * Line Properties::
1369 * Text Properties:: 1369 * Text Properties::
1370 * Image Properties:: 1370 * Image Properties::
1371 * Patch Properties:: 1371 * Patch Properties::
1372 * Surface Properties:: 1372 * Surface Properties::
1373 * Uimenu Properties::
1374 * Uicontextmenu Properties::
1375 * Uipanel Properties::
1376 * Uicontrol Properties::
1377 * Uitoolbar Properties::
1378 * Uipushtool Properties::
1379 * Uitoggletool Properties::
1373 @end menu 1380 @end menu
1374 1381
1375 In this Section the graphics object properties are discussed in detail, starting 1382 In this Section the graphics object properties are discussed in detail, starting
1376 with the root figure properties and continuing through the objects 1383 with the root figure properties and continuing through the objects
1377 hierarchy. The documentation about a specific graphics object can be displayed 1384 hierarchy. The documentation about a specific graphics object can be displayed
1453 1460
1454 The @code{surface} properties are: 1461 The @code{surface} properties are:
1455 1462
1456 @include plot-surfaceproperties.texi 1463 @include plot-surfaceproperties.texi
1457 1464
1465 @node Uimenu Properties
1466 @subsubsection Uimenu Properties
1467 @cindex uimenu properties
1468
1469 The @code{uimenu} properties are:
1470
1471 @include plot-uimenuproperties.texi
1472
1473 @node Uicontextmenu Properties
1474 @subsubsection Uicontextmenu Properties
1475 @cindex uicontextmenu properties
1476
1477 The @code{uicontextmenu} properties are:
1478
1479 @include plot-uicontextmenuproperties.texi
1480
1481 @node Uipanel Properties
1482 @subsubsection Uipanel Properties
1483 @cindex uipanel properties
1484
1485 The @code{uipanel} properties are:
1486
1487 @include plot-uipanelproperties.texi
1488
1489 @node Uicontrol Properties
1490 @subsubsection Uicontrol Properties
1491 @cindex uicontrol properties
1492
1493 The @code{uicontrol} properties are:
1494
1495 @include plot-uicontrolproperties.texi
1496
1497 @node Uitoolbar Properties
1498 @subsubsection Uitoolbar Properties
1499 @cindex uitoolbar properties
1500
1501 The @code{uitoolbar} properties are:
1502
1503 @include plot-uitoolbarproperties.texi
1504
1505 @node Uipushtool Properties
1506 @subsubsection Uipushtool Properties
1507 @cindex uipushtool properties
1508
1509 The @code{uipushtool} properties are:
1510
1511 @include plot-uipushtoolproperties.texi
1512
1513 @node Uitoggletool Properties
1514 @subsubsection Uitoggletool Properties
1515 @cindex uitoggletool properties
1516
1517 The @code{uitoggletool} properties are:
1518
1519 @include plot-uitoggletoolproperties.texi
1458 1520
1459 @node Searching Properties 1521 @node Searching Properties
1460 @subsection Searching Properties 1522 @subsection Searching Properties
1461 1523
1462 @DOCSTRING(findobj) 1524 @DOCSTRING(findobj)