Home > mpt > extras > auxiliary > sbprogress.m

sbprogress

PURPOSE ^

[nph,nfh] = function SBPROGRESS(ph,x,msg,fh,title,modal)

SYNOPSIS ^

function [nph,nfh] = sbprogress(ph,x,msg,fh,title,modal)

DESCRIPTION ^

[nph,nfh] = function SBPROGRESS(ph,x,msg,fh,title,modal)
   Creates a progress bar in the "status-bar section" of the figure.

   - ph:   progress-bar axis handle; empty if one is to be created
   - x:    can have a numerical value (-100..0..100) or any of the two
           strings: 'close' or 'redraw'. Progress (x) with negative values means that
           the percent number will not be displayed.
           x given as the 'close' string closes an existing progress bar (ph) (and corresponding figure
           if figure was created when sbprogress was called otherwise only  the progress bar will be removed from the figure).
           x given as the 'redraw' string redraws an existing ph (progress
           bar) - useful when figure changes its size for example.
   - msg:  msg text (string)
   - fh:   (optional) figure handle that progress bar lies on (if empty, a
           new figure will be created)
   - title:title when a new figure is raised (when fh is empty or
           non-existing).
   - modal:in case a new figure is raised, it can be raised as modal
           window (default = 0).

   - nph:  a handle to a newly created or existing progress-bar axis
   - nfh:  a handle to a newly created or existing figure

   EXAMPLES:   
   sbprogress
           Runs a demo
   sbprogress([],10,'Progress:',[],'Test progress',0)
           Creates a new figure with a progress bar...
   ph = sbprogress([],-10,'Progress:',[],'Test progress',0)
           Creates a new figure with a progress bar where the percent
           number is not shown; a handle array to the progress-bar axis is returned
   sbprogress(ph,'redraw')
           Redraws the ph progress bar
   sbprogress(ph,20)
           Re-sets the progress-bar's progress
   sbprogress([],20,'Test',fh)
           Creates a progress bar on an existing figure fh
   sbprogress(ph,'redraw')
           Redraws an existing progress bar designated by ph handle-array

   NOTES: when the progress-bar's percentage is changed, the bar will be redrawn too. 

   Primoz Cermelj, 08.12.2002
   (c) Primoz Cermelj, primoz.cermelj@email.si

   Last revision: 28.01.2004
--------------------------------------------------------------------------

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Thu 30-Mar-2006 10:26:47 by m2html © 2003