|
2847
|
1 ## Copyright (C) 1996, 1997 John W. Eaton |
|
2313
|
2 ## |
|
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
|
6 ## under the terms of the GNU General Public License as published by |
|
|
7 ## the Free Software Foundation; either version 2, or (at your option) |
|
|
8 ## any later version. |
|
|
9 ## |
|
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
13 ## General Public License for more details. |
|
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
|
16 ## along with Octave; see the file COPYING. If not, write to the Free |
|
|
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA |
|
|
18 ## 02111-1307, USA. |
|
245
|
19 |
|
3368
|
20 ## -*- texinfo -*- |
|
|
21 ## @deftypefn {Function File} {} title (@var{string}) |
|
|
22 ## Specify a title for a plot. If you already have a plot displayed, use |
|
|
23 ## the command @code{replot} to redisplay it with the new title. |
|
|
24 ## @end deftypefn |
|
5053
|
25 ## |
|
3407
|
26 ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, |
|
3408
|
27 ## bar, stairs, gplot, gsplot, replot, xlabel, and ylabel} |
|
4
|
28 |
|
2314
|
29 ## Author: jwe |
|
|
30 |
|
4529
|
31 function h = title (text) |
|
4
|
32 |
|
|
33 if (nargin != 1) |
|
904
|
34 usage ("title (text)"); |
|
4
|
35 endif |
|
|
36 |
|
|
37 if (isstr (text)) |
|
3619
|
38 eval (sprintf ("gset title \"%s\"", |
|
|
39 undo_string_escapes (undo_string_escapes (text)))); |
|
4
|
40 else |
|
904
|
41 error ("title: text must be a string"); |
|
4
|
42 endif |
|
|
43 |
|
4529
|
44 ## XXX FIXME XXX -- eventually, we will return a graphics handle. For |
|
|
45 ## now, return something, so that calls that expect a handle won't |
|
|
46 ## fail (at least immediately). |
|
|
47 |
|
|
48 if (nargout > 0) |
|
|
49 h = -1; |
|
|
50 endif |
|
|
51 |
|
4
|
52 endfunction |
