Mercurial > octave

## Copyright (C) 1993-2012 John W. Eaton
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {} title (@var{string})
## @deftypefnx {Function File} {} title (@var{string}, @var{prop}, @var{val}, @dots{})
## @deftypefnx {Function File} {} title (@var{hax}, @dots{})
## @deftypefnx {Function File} {@var{h} =} title (@dots{})
## Specify the string used as a title for the current axis.
##
## An optional list of @var{property}/@var{value} pairs can be used to change
## the appearance of the created title text object.
##
## If the first argument @var{hax} is an axes handle, then plot into this axis,
## rather than the current axes returned by @code{gca}.
##
## The optional return value @var{h} is a graphics handle to the created text
## object.
## @seealso{xlabel, ylabel, zlabel, text}
## @end deftypefn

## Author: jwe

function h = title (varargin)

  [hax, varargin, nargin] = __plt_get_axis_arg__ ("title", varargin{:});

  if (isempty (hax))
    hax = gca ();
  endif

  if (rem (nargin, 2) != 1)
    print_usage ();
  endif

  htmp = __axis_label__ (hax, "title", varargin{:});

  if (nargout > 0)
    h = htmp;
  endif

endfunction


%!demo
%! clf;
%! ax = axes ();
%! h = get (ax, 'title');
%! title ('Testing title');
%! assert (get (h, 'string'), 'Testing title');

%!demo
%! clf;
%! plot3 ([0,1], [0,1], [0,1]);
%! h = get (gca, 'title');
%! title ('Testing title', 'fontsize', 16);
%! assert (get (h, 'string'), 'Testing title');
%! assert (get (h, 'fontsize'), 16);

%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   ax = axes ();
%!   h = get (ax, "title");
%!   title ("Testing title");
%!   assert (get (h, "string"), "Testing title");
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   plot3 ([0,1], [0,1], [0,1]);
%!   h = get (gca, "title");
%!   title ("Testing title");
%!   assert (get (h, "string"), "Testing title");
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect
author	Rik <rik@octave.org>
date	Wed, 31 Jul 2013 13:53:30 -0700
parents	3f99d7d22bd0
children	df4c4b7708a4