GNEGroupBoxModule.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2006-2025 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
/****************************************************************************/
//
/****************************************************************************/
 
#pragma once
#include <config.h>
#include <string>
 
#include <utils/foxtools/fxheader.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class GNEFrame;
class MFXButtonTooltip;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEGroupBoxModule : protected FXVerticalFrame {
    FXDECLARE(GNEGroupBoxModule)
 
public:
    enum Options {
        NOTHING =       1 << 0, // Basic GroupBox
        COLLAPSIBLE =   1 << 1, // Collapsible groupBox
        EXTENSIBLE =    1 << 2, // Extensible groupBox
        SAVE =          1 << 3, // Save contents
        LOAD =          1 << 4, // Load contents
    };
 
    GNEGroupBoxModule(GNEFrame* frame, const std::string& text, const int options = Options::COLLAPSIBLE);
 
    GNEGroupBoxModule(FXVerticalFrame* contentFrame, const std::string& text, const int options = Options::NOTHING);
 
    ~GNEGroupBoxModule();
 
    void setText(const std::string& text);
 
    FXVerticalFrame* getCollapsableFrame();
 
    long onPaint(FXObject*, FXSelector, void*);
 
    long onCmdCollapseButton(FXObject*, FXSelector, void*);
 
    long onCmdExtendButton(FXObject*, FXSelector, void*);
 
    long onCmdResetButton(FXObject*, FXSelector, void*);
 
    long onUpdResetButton(FXObject*, FXSelector, void*);
 
    long onCmdSaveButton(FXObject*, FXSelector, void*);
 
    long onCmdLoadButton(FXObject*, FXSelector, void*);
 
protected:
    GNEGroupBoxModule();
 
    virtual bool saveContents() const;
 
    virtual bool loadContents() const;
 
    void toggleSaveButton(const bool value);
 
private:
    const int myOptions;
 
    GNEFrame* myFrameParent = nullptr;
 
    FXVerticalFrame* myCollapsableFrame = nullptr;
 
    FXLabel* myLabel = nullptr;
 
    FXButton* myCollapseButton = nullptr;
 
    MFXButtonTooltip* myExtendButton = nullptr;
 
    FXButton* myResetWidthButton = nullptr;
 
    FXButton* mySaveButton = nullptr;
 
    FXButton* myLoadButton = nullptr;
 
    bool myCollapsed;
};