ResInsight/Fwk/AppFwk/cafProjectDataModel/cafPdmUiCore/cafPdmUiOrdering.h

//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2013 Ceetron AS
//
//   This library may be used under the terms of either the GNU General Public License or
//   the GNU Lesser General Public License as follows:
//
//   GNU General Public License Usage
//   This library 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.
//
//   This library 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 at <<http://www.gnu.org/licenses/gpl.html>>
//   for more details.
//
//   GNU Lesser General Public License Usage
//   This library is free software; you can redistribute it and/or modify
//   it under the terms of the GNU Lesser General Public License as published by
//   the Free Software Foundation; either version 2.1 of the License, or
//   (at your option) any later version.
//
//   This library 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 Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//   for more details.
//
//##################################################################################################

#pragma once

#include "cafPdmUiItem.h"

#include <QString>
#include <vector>

namespace caf 
{

class PdmUiGroup;
class PdmFieldHandle;
class PdmObjectHandle;

//==================================================================================================
/// Class storing the order and grouping of fields and groups of fields etc. to be used in the Gui
//==================================================================================================

class PdmUiOrdering
{
public:
    struct LayoutOptions
    {
        static const int MAX_COLUMN_SPAN = -1;
        LayoutOptions(bool newRow = true, int totalColumnSpan = MAX_COLUMN_SPAN, int leftLabelColumnSpan = MAX_COLUMN_SPAN)
            : newRow(newRow), totalColumnSpan(totalColumnSpan), leftLabelColumnSpan(leftLabelColumnSpan)
        {}

        bool newRow;
        int totalColumnSpan;
        int leftLabelColumnSpan;
    };
    typedef std::pair<PdmUiItem*, LayoutOptions> FieldAndLayout;

    PdmUiOrdering(): m_skipRemainingFields(false) { };
    virtual ~PdmUiOrdering();

    PdmUiOrdering(const PdmUiOrdering&) = delete;
    PdmUiOrdering& operator=(const PdmUiOrdering&) = delete;

    void                            add(const PdmFieldHandle* field, LayoutOptions layout = LayoutOptions());
    void                            add(const PdmObjectHandle* obj,  LayoutOptions layout = LayoutOptions());
    bool                            insertBeforeGroup(const QString& groupId, const PdmFieldHandle* fieldToInsert, LayoutOptions layout = LayoutOptions());
    bool                            insertBeforeItem(const PdmUiItem* item,   const PdmFieldHandle* fieldToInsert, LayoutOptions layout = LayoutOptions());

    PdmUiGroup*                     addNewGroup(const QString& displayName, LayoutOptions layout = LayoutOptions());
    PdmUiGroup*                     createGroupBeforeGroup(const QString& groupId, const QString& displayName, LayoutOptions layout = LayoutOptions());
    PdmUiGroup*                     createGroupBeforeItem(const PdmUiItem* item,   const QString& displayName, LayoutOptions layout = LayoutOptions());

    PdmUiGroup*                     addNewGroupWithKeyword(const QString& displayName, const QString& groupKeyword, LayoutOptions layout = LayoutOptions());
    PdmUiGroup*                     createGroupWithIdBeforeGroup(const QString& groupId, const QString& displayName, const QString& newGroupId, LayoutOptions layout = LayoutOptions());
    PdmUiGroup*                     createGroupWithIdBeforeItem(const PdmUiItem* item,   const QString& displayName, const QString& newGroupId, LayoutOptions layout = LayoutOptions());

    PdmUiGroup*                     findGroup(const QString& groupId) const;

    void                            skipRemainingFields(bool doSkip = true);

    // Pdm internal methods

    const std::vector<PdmUiItem*>          uiItems() const;
    const std::vector<FieldAndLayout>&     uiItemsWithLayout() const;
    int                                    nrOfColumns() const;
    bool                                   contains(const PdmUiItem* item) const;
    bool                                   isIncludingRemainingFields() const;

protected:

    struct PositionFound
    {
        PdmUiOrdering* parent;
        size_t indexInParent;
        PdmUiItem* item();
        PdmUiGroup* group();
    };

    PositionFound                   findGroupPosition(const QString& groupKeyword) const;
    PositionFound                   findItemPosition(const PdmUiItem* item) const;

private:
    void                            insert(size_t index, const PdmFieldHandle* field, LayoutOptions layout = LayoutOptions());
    PdmUiGroup*                     insertNewGroupWithKeyword(size_t index, const QString& displayName, const QString& groupKeyword, LayoutOptions layout = LayoutOptions());

    std::vector<FieldAndLayout>     m_ordering;            ///< The order of groups and fields
    std::vector<PdmUiGroup*>        m_createdGroups;       ///< Owned PdmUiGroups, for memory management only
    bool                            m_skipRemainingFields;
};

} // End of namespace caf

#include "cafPdmUiGroup.h"