lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _SELECTION_H_
lbajardsilogic@0: #define _SELECTION_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include <cstddef>
lbajardsilogic@0: #include <set>
lbajardsilogic@0: 
lbajardsilogic@0: #include "XmlExportable.h"
lbajardsilogic@0: 
lbajardsilogic@0: class Selection
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     Selection();
lbajardsilogic@0:     Selection(size_t startFrame, size_t endFrame);
lbajardsilogic@0:     Selection(const Selection &);
lbajardsilogic@0:     Selection &operator=(const Selection &);
lbajardsilogic@0:     virtual ~Selection();
lbajardsilogic@0: 
lbajardsilogic@0:     bool isEmpty() const;
lbajardsilogic@0:     size_t getStartFrame() const;
lbajardsilogic@0:     size_t getEndFrame() const;
lbajardsilogic@0:     bool contains(size_t frame) const;
lbajardsilogic@0: 
lbajardsilogic@0:     bool operator<(const Selection &) const;
lbajardsilogic@0:     bool operator==(const Selection &) const;
lbajardsilogic@0:     
lbajardsilogic@0: protected:
lbajardsilogic@0:     size_t m_startFrame;
lbajardsilogic@0:     size_t m_endFrame;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: class MultiSelection : public XmlExportable
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     MultiSelection();
lbajardsilogic@0:     virtual ~MultiSelection();
lbajardsilogic@0: 
lbajardsilogic@0:     typedef std::set<Selection> SelectionList;
lbajardsilogic@0: 
lbajardsilogic@0:     const SelectionList &getSelections() const;
lbajardsilogic@0:     void setSelection(const Selection &selection);
lbajardsilogic@0:     void addSelection(const Selection &selection);
lbajardsilogic@0:     void removeSelection(const Selection &selection);
lbajardsilogic@0:     void clearSelections();
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the selection that contains a given frame.
lbajardsilogic@0:      * If defaultToFollowing is true, and if the frame is not in a
lbajardsilogic@0:      * selected area, return the next selection after the given frame.
lbajardsilogic@0:      * Return the empty selection if no appropriate selection is found.
lbajardsilogic@0:      */
lbajardsilogic@0:     Selection getContainingSelection(size_t frame, bool defaultToFollowing) const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual QString toXmlString(QString indent = "",
lbajardsilogic@0: 				QString extraAttributes = "") const;
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     SelectionList m_selections;
lbajardsilogic@0: };
lbajardsilogic@0:     
lbajardsilogic@0: 
lbajardsilogic@0: #endif