progress.h

Go to the documentation of this file.

/*
 * Copyright (C) 2010 Carl Hetherington <carl@carlh.net>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef _libpbd_progress_h_
#define _libpbd_progress_h_
 
#include <list>
 
#include "pbd/libpbd_visibility.h"
 
namespace PBD {
 
class LIBPBD_API Progress
{
public:
        Progress ();
        virtual ~Progress () {}
        void set_progress (float);
 
        void ascend ();
        void descend (float);
 
        bool cancelled () const;
 
protected:
        void cancel ();
 
private:
        virtual void set_overall_progress (float p) = 0;
 
        struct Level {
                Level (float a) : allocation (a), normalised (0) {}
 
                float allocation;
                float normalised;
        };
 
        std::list<Level> _stack;
        bool _cancelled;
};
 
}
 
#endif