Mercurial > octave-nkf

comparison doc/interpreter/genpropdoc.m @ 20628:3af34e1ef330

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 a9a1f021d96b
children
comparison
equal deleted inserted replaced
20627:56333f6df823 20628:3af34e1ef330
28 ## @seealso{} 28 ## @seealso{}
29 ## @end deftypefn 29 ## @end deftypefn
30 30
31 function genpropdoc (objname, fname) 31 function genpropdoc (objname, fname)
32 objnames = {"root", "figure", "axes", "line", ... 32 objnames = {"root", "figure", "axes", "line", ...
33 "text", "image", "patch", "surface"}; 33 "text", "image", "patch", "surface", ...
34 "uimenu", "uicontextmenu", "uipanel", ...
35 "uicontrol", "uitoolbar", "uipushtool", "uitoggletool"};
34 36
35 ## Base properties 37 ## Base properties
36 base = getstructure ("base"); 38 base = getstructure ("base");
37 39
38 ## Object properties 40 ## Object properties
1233 1235
1234 case "zdata" 1236 case "zdata"
1235 s.valid = valid_vecmat; 1237 s.valid = valid_vecmat;
1236 1238
1237 endswitch 1239 endswitch
1240
1241 ## uimenu properties
1242 elseif (strcmp (objname, "uimenu"))
1243 switch (field)
1244 ## Overridden shared properties
1245 case "buttondownfcn"
1246 s.doc = doc_unused;
1247
1248 ## Specific properties
1249 case "accelerator"
1250 case "callback"
1251 case "checked"
1252 case "enable"
1253 case "foregroundcolor"
1254 case "label"
1255 case "position"
1256 case "separator"
1257
1258 endswitch
1259
1260 ## uicontextmenu properties
1261 elseif (strcmp (objname, "uicontextmenu"))
1262 switch (field)
1263 ## Overridden shared properties
1264 case "buttondownfcn"
1265 s.doc = doc_unused;
1266
1267 ## Specific properties
1268 case "callback"
1269 case "position"
1270
1271 endswitch
1272
1273 ## uipanel properties
1274 elseif (strcmp (objname, "uipanel"))
1275 switch (field)
1276 ## Overridden shared properties
1277
1278 ## Specific properties
1279 case "backgroundcolor"
1280 case "bordertype"
1281 case "borderwidth"
1282 case "fontangle"
1283 case "fontname"
1284 case "fontsize"
1285 case "fontunits"
1286 case "fontweight"
1287 case "foregroundcolor"
1288 case "highlightcolor"
1289 case "position"
1290 case "resizefcn"
1291 case "shadowcolor"
1292 case "title"
1293 case "titleposition"
1294 case "units"
1295
1296 endswitch
1297
1298 ## uicontrol properties
1299 elseif (strcmp (objname, "uicontrol"))
1300 switch (field)
1301 ## Overridden shared properties
1302
1303 ## Specific properties
1304 case "backgroundcolor"
1305 case "callback"
1306 case "cdata"
1307 case "enable"
1308 case "extent"
1309 case "fontangle"
1310 case "fontname"
1311 case "fontsize"
1312 case "fontunits"
1313 case "fontweight"
1314 case "foregroundcolor"
1315 case "horizontalalignment"
1316 case "keypressfcn"
1317 case "listboxtop"
1318 case "max"
1319 case "min"
1320 case "position"
1321 case "sliderstep"
1322 case "string"
1323 case "style"
1324 case "tooltipstring"
1325 case "units"
1326 case "value"
1327 case "verticalalignment"
1328
1329 endswitch
1330
1331 ## uitoolbar properties
1332 elseif (strcmp (objname, "uitoolbar"))
1333 switch (field)
1334 ## Overridden shared properties
1335 case "buttondownfcn"
1336 s.doc = doc_unused;
1337
1338 endswitch
1339
1340 ## uipushtool properties
1341 elseif (strcmp (objname, "uipushtool"))
1342 switch (field)
1343 ## Overridden shared properties
1344 case "buttondownfcn"
1345 s.doc = doc_unused;
1346
1347 ## Specific properties
1348 case "cdata"
1349 case "clickedcallback"
1350 case "enable"
1351 case "separator"
1352 case "tooltipstring"
1353
1354 endswitch
1355
1356 ## uitoggletool properties
1357 elseif (strcmp (objname, "uitoggletool"))
1358 switch (field)
1359 ## Overridden shared properties
1360 case "buttondownfcn"
1361 s.doc = doc_unused;
1362
1363 ## Specific properties
1364 case "cdata"
1365 case "clickedcallback"
1366 case "enable"
1367 case "offcallback"
1368 case "oncallback"
1369 case "separator"
1370 case "state"
1371 case "tooltipstring"
1372
1373 endswitch
1238 endif 1374 endif
1239 1375
1240 ## Replace keywords 1376 ## Replace keywords
1241 if (! isempty (s.doc) && ! strcmp (objname, "base")) 1377 if (! isempty (s.doc) && ! strcmp (objname, "base"))
1242 s.doc = expand_doc (s.doc, field, objname); 1378 s.doc = expand_doc (s.doc, field, objname);