Mercurial > octave
view scripts/plot/appearance/orient.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2001-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} orient (@var{orientation}) ## @deftypefnx {} {} orient (@var{hfig}, @var{orientation}) ## @deftypefnx {} {@var{orientation} =} orient () ## @deftypefnx {} {@var{orientation} =} orient (@var{hfig}) ## Query or set the print orientation for figure @var{hfig}. ## ## Valid values for @var{orientation} are @qcode{"portrait"}, ## @qcode{"landscape"}, and @qcode{"tall"}. ## ## The @qcode{"landscape"} option changes the orientation so the plot width ## is larger than the plot height. The @qcode{"paperposition"} is also ## modified so that the plot fills the page, while leaving a 0.25 inch border. ## ## The @qcode{"tall"} option sets the orientation to @qcode{"portrait"} and ## fills the page with the plot, while leaving a 0.25 inch border. ## ## The @qcode{"portrait"} option (default) changes the orientation so the plot ## height is larger than the plot width. It also restores the default ## @qcode{"paperposition"} property. ## ## When called with no arguments, return the current print orientation. ## ## If the argument @var{hfig} is omitted, then operate on the current figure ## returned by @code{gcf}. ## @seealso{print, saveas} ## @end deftypefn function orientation = orient (varargin) cf = []; if (nargin > 0 && isscalar (varargin{1}) && isfigure (varargin{1})) cf = varargin{1}; varargin(1) = []; nargin = nargin - 1; endif if (nargin > 1) print_usage (); endif if (isempty (cf)) cf = gcf (); endif paperunits = get (cf, "paperunits"); unwind_protect set (cf, "paperunits", "inches"); # All Matlab calculations assume inches. if (nargin == 0) orientation = get (cf, "paperorientation"); if (strcmp (orientation, "portrait")) papersize = get (cf, "papersize"); paperposition = get (cf, "paperposition"); if (paperposition == [0.25 0.25 (papersize - 0.5)]) orientation = "tall"; endif endif else paporient = varargin{1}; if (strcmpi (paporient, "landscape") || strcmpi (paporient, "portrait")) if (! strcmpi (get (cf, "paperorientation"), paporient)) ## FIXME: with the proper listeners in place there won't be a need to ## set the papersize and paperposition here. papersize = get (cf, "papersize"); paperposition = get (cf, "paperposition"); set (cf, "paperorientation", paporient, "papersize", papersize([2, 1]), "paperposition", paperposition([2, 1, 4, 3])); endif if (strcmpi (paporient, "portrait")) ## portrait restores the default ## FIXME: Should use "default" here, but Octave complains ## that "paperposition" is not a default property. set (cf, "paperposition", "factory"); else ## landscape also sets the plot to occupy the entire page papersize = get (cf, "papersize"); set (cf, "paperposition", [0.25, 0.25, (papersize - 0.5)]); endif elseif (strcmpi (paporient, "tall")) orient ("portrait"); papersize = get (cf, "papersize"); set (cf, "paperposition", [0.25, 0.25, (papersize - 0.5)]); else error ("orient: unknown ORIENTATION"); endif endif unwind_protect_cleanup set (cf, "paperunits", paperunits); end_unwind_protect endfunction %!test %! papersize = [8.5, 11]; %! paperposition = [1.342185258002766, 3.319138943502075, 5.815629483994468, 4.361722112995850]; %! fullpaperposition = [0.25, 0.25, (papersize-0.5)]; %! hfig = figure ("visible", "off"); %! unwind_protect %! set (hfig, "paperunits", "inches"); %! set (hfig, "paperorientation", "portrait"); %! set (hfig, "papersize", papersize); %! set (hfig, "paperposition", paperposition); %! %! orient portrait; %! assert (orient, "portrait"); # default %! assert (get (hfig, "papersize"), papersize); %! assert (get (hfig, "paperposition"), paperposition); %! %! orient landscape; %! assert (orient,"landscape"); # change to landscape %! assert (get (hfig, "papersize"), papersize([2, 1])); %! assert (get (hfig, "paperposition"), fullpaperposition([1, 2, 4, 3])); %! %! orient portrait # change back to portrait %! assert (orient, "portrait"); %! assert (get (hfig, "papersize"), papersize); %! assert (get (hfig, "paperposition"), paperposition); %! %! orient landscape; %! orient tall; %! assert (orient, "tall"); %! assert (get (hfig, "papersize"), papersize); %! assert (get (hfig, "paperposition"), fullpaperposition); %! %! orient portrait # errors don't change the state %! assert (orient, "portrait"); %! assert (get (hfig, "papersize"), papersize); %! assert (get (hfig, "paperposition"), paperposition); %! unwind_protect_cleanup %! close (hfig); %! end_unwind_protect ## Test input validation %!error orient (1.73, 2.5) %!error <unknown ORIENTATION> %! hfig = figure ("visible", "off"); %! unwind_protect %! orient ("nobody"); %! unwind_protect_cleanup %! close (hfig); %! end_unwind_protect