HasUnsavedChanges.h

Go to the documentation of this file.

#ifndef GUI_HASUNSAVEDCHANGES_H_INCLUDED
#define GUI_HASUNSAVEDCHANGES_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include <string>
#include <vector>

namespace SimShell {
namespace Gui {

class HasUnsavedChanges
{
public:
        typedef std::vector<HasUnsavedChanges*> ChildrenType;

        HasUnsavedChanges(std::string&& title);

        virtual ~HasUnsavedChanges();

        ChildrenType::iterator begin();

        ChildrenType::const_iterator begin() const;

        ChildrenType::iterator end();

        ChildrenType::const_iterator end() const;

        void ForceClose();

        const std::string& GetTitle();

        bool IsClean() const;

        virtual bool IsOpened() const = 0;

        bool Save();

        bool SaveAndClose();

protected:
        void AddChild(ChildrenType::value_type&& v);

        void SetChildren(ChildrenType&& c);

        virtual void InternalForceClose() = 0;

        virtual bool InternalIsClean() const = 0;

        virtual void InternalPreForceClose() {}

        virtual bool InternalSave() = 0;

private:
        std::string    m_title;
        ChildrenType   m_children;
};

class HasUnsavedChangesDummy : public HasUnsavedChanges
{
public:
        HasUnsavedChangesDummy() : HasUnsavedChanges("Dummy"), m_opened(true) {}

        void SetChildren(ChildrenType&& c) { HasUnsavedChanges::SetChildren(move(c)); }

        virtual bool IsOpened() const { return m_opened; }

protected:
        virtual void InternalForceClose() { m_opened = false; }
        virtual bool InternalIsClean() const { return true; }
        virtual bool InternalSave() { return true; }

private:
        bool m_opened;
};

} // namespace
} // namespace

#endif // end_of_inclde_guard