GNEFrameAttributeModules.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Auxiliar class for GNEFrame Modules (only for attributes edition)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNEAttributeCarrier.h>
#include <netedit/GNEViewNetHelper.h>
#include <utils/common/Parameterised.h>
#include <utils/foxtools/MFXGroupBoxModule.h>
#include <utils/foxtools/MFXToggleButtonTooltip.h>
#include <utils/foxtools/MFXTextFieldTooltip.h>
#include <utils/foxtools/MFXLabelTooltip.h>
#include <utils/xml/CommonXMLStructure.h>
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEFrame;
class GNEViewParent;
class GNEFlowEditor;
class GNEInspectorFrame;
class GNETypeFrame;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEFrameAttributeModules {
 
public:
    // ===========================================================================
    // class declaration
    // ===========================================================================
 
    class AttributesEditor;
    class AttributesEditorFlow;
 
    // ===========================================================================
    // class AttributesEditorRow
    // ===========================================================================
 
    class AttributesEditorRow : protected FXHorizontalFrame {
        FXDECLARE(GNEFrameAttributeModules::AttributesEditorRow)
 
    public:
        AttributesEditorRow(AttributesEditor* attributeEditorParent, const GNEAttributeProperties& ACAttr, const std::string& value,
                            const bool attributeEnabled, const bool computed, GNEAttributeCarrier* ACParent);
 
        void destroy();
 
        void refreshAttributesEditorRow(const std::string& value, const bool forceRefreshAttribute, const bool attributeEnabled, const bool computed, GNEAttributeCarrier* ACParent);
 
        bool isAttributesEditorRowValid() const;
 
 
        long onCmdSetAttribute(FXObject*, FXSelector, void*);
 
        long onCmdSelectCheckButton(FXObject*, FXSelector, void*);
 
        long onCmdOpenColorDialog(FXObject*, FXSelector, void*);
 
        long onCmdOpenAllowDialog(FXObject*, FXSelector, void*);
 
        long onCmdInspectParent(FXObject*, FXSelector, void*);
 
        long onCmdMoveElementLaneUp(FXObject*, FXSelector, void*);
 
        long onCmdMoveElementLaneDown(FXObject*, FXSelector, void*);
 
 
    protected:
        AttributesEditorRow();
 
        std::string stripWhitespaceAfterComma(const std::string& stringValue);
 
        bool mergeJunction(SumoXMLAttr attr, const std::string& newVal) const;
 
    private:
        AttributesEditor* myAttributesEditorParent;
 
        const GNEAttributeProperties myACAttr;
 
        MFXLabelTooltip* myAttributeLabel = nullptr;
 
        FXCheckButton* myAttributeCheckButton = nullptr;
 
        MFXButtonTooltip* myAttributeButton = nullptr;
 
        MFXTextFieldTooltip* myValueTextField = nullptr;
 
        MFXComboBoxIcon* myValueComboBox = nullptr;
 
        FXCheckButton* myValueCheckButton = nullptr;
 
        MFXButtonTooltip* myValueLaneUpButton = nullptr;
 
        MFXButtonTooltip* myValueLaneDownButton = nullptr;
 
        GNEAttributeCarrier* myACParent = nullptr;
 
        void buildAttributeElements(const bool attributeEnabled, const bool computed);
 
        void buildValueElements(const bool attributeEnabled, const bool computed);
 
        void refreshAttributeElements(const std::string& value, const bool attributeEnabled, const bool computed);
 
        void refreshValueElements(const std::string& value,  const bool attributeEnabled, const bool computed, const bool forceRefreshAttribute);
 
        void fillComboBox(const std::string& value);
 
        void updateMoveLaneButtons(const std::string& value);
 
        AttributesEditorRow(AttributesEditorRow*) = delete;
 
        AttributesEditorRow& operator=(AttributesEditorRow*) = delete;
    };
 
    // ===========================================================================
    // class AttributesEditor
    // ===========================================================================
 
    class AttributesEditor : public MFXGroupBoxModule {
        FXDECLARE(GNEFrameAttributeModules::AttributesEditor)
 
    public:
        AttributesEditor(GNEFrame* inspectorFrameParent);
 
        void showAttributeEditorModule(bool includeExtended);
 
        void hideAttributesEditorModule();
 
        void refreshAttributeEditor(bool forceRefreshShape, bool forceRefreshPosition);
 
        GNEFrame* getFrameParent() const;
 
        long onCmdAttributesEditorHelp(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(AttributesEditor)
 
    private:
        GNEFrame* myFrameParent;
 
        GNEFlowEditor* myAttributesEditorFlow = nullptr;
 
        std::vector<AttributesEditorRow*> myAttributesEditorRows;
 
        FXButton* myHelpButton = nullptr;
 
        bool myIncludeExtended;
    };
 
    // ===========================================================================
    // class AttributesEditorExtended
    // ===========================================================================
 
    class AttributesEditorExtended : public MFXGroupBoxModule {
        FXDECLARE(GNEFrameAttributeModules::AttributesEditorExtended)
 
    public:
        AttributesEditorExtended(GNEFrame* frameParent);
 
        ~AttributesEditorExtended();
 
        void showAttributesEditorExtendedModule();
 
        void hideAttributesEditorExtendedModule();
 
        long onCmdOpenDialog(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(AttributesEditorExtended)
 
    private:
        GNEFrame* myFrameParent = nullptr;
    };
 
    // ===========================================================================
    // class GenericDataAttributes
    // ===========================================================================
 
    class GenericDataAttributes : public MFXGroupBoxModule {
        FXDECLARE(GNEFrameAttributeModules::GenericDataAttributes)
 
    public:
        GenericDataAttributes(GNEFrame* frameParent);
 
        ~GenericDataAttributes();
 
        void showGenericDataAttributes();
 
        void hideGenericDataAttributes();
 
        void refreshGenericDataAttributes();
 
        const Parameterised::Map& getParametersMap() const;
 
        std::string getParametersStr() const;
 
        std::vector<std::pair<std::string, std::string> > getParameters() const;
 
        void setParameters(const std::vector<std::pair<std::string, std::string> >& parameters);
 
        GNEFrame* getFrameParent() const;
 
        bool areAttributesValid() const;
 
        long onCmdEditParameters(FXObject*, FXSelector, void*);
 
        long onCmdSetParameters(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(GenericDataAttributes)
 
    private:
        GNEFrame* myFrameParent = nullptr;
 
        Parameterised::Map myParameters;
 
        FXTextField* myTextFieldParameters = nullptr;
 
        FXButton* myButtonEditParameters = nullptr;
    };
 
    // ===========================================================================
    // class ParametersEditor
    // ===========================================================================
 
    class ParametersEditor : public MFXGroupBoxModule {
        FXDECLARE(GNEFrameAttributeModules::ParametersEditor)
 
    public:
        ParametersEditor(GNEInspectorFrame* inspectorFrameParent);
 
        ParametersEditor(GNETypeFrame* typeFrameParent);
 
        ~ParametersEditor();
 
        GNEViewNet* getViewNet() const;
 
        void showParametersEditor();
 
        void hideParametersEditor();
 
        void refreshParametersEditor();
 
        GNEInspectorFrame* getInspectorFrameParent() const;
 
        GNETypeFrame* getTypeFrameParent() const;
 
        long onCmdEditParameters(FXObject*, FXSelector, void*);
 
        long onCmdSetParameters(FXObject*, FXSelector, void*);
 
    protected:
        FOX_CONSTRUCTOR(ParametersEditor)
 
    private:
        GNEInspectorFrame* myInspectorFrameParent = nullptr;
 
        GNETypeFrame* myTypeFrameParent = nullptr;
 
        FXTextField* myTextFieldParameters = nullptr;
 
        FXButton* myButtonEditParameters = nullptr;
    };
 
    static bool isSupermodeValid(const GNEViewNet* viewNet, const GNEAttributeCarrier* AC);
 
    static bool isSupermodeValid(const GNEViewNet* viewNet, const GNEAttributeProperties& ACAttr);
};