GNEFileDialog.cpp

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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
/****************************************************************************/
// Dialog used for opening/saving files
/****************************************************************************/
 
#include <utils/foxtools/MFXTextFieldIcon.h>
#include <utils/gui/div/GUIIOGlobals.h>
#include <netedit/GNEApplicationWindow.h>
 
#include "GNEFileDialog.h"
#include "GNEFileSelector.h"
 
// ===========================================================================
// member method definitions
// ===========================================================================
 
GNEFileDialog::GNEFileDialog(GNEApplicationWindow* applicationWindow, const std::string elementFile,
                             const std::vector<std::string>& extensions, GNEFileDialog::OpenMode openMode,
                             GNEFileDialog::ConfigType configType, const std::string initialFolder) :
    GNEDialog(applicationWindow, TLF("Save % as", elementFile), GUIIcon::SAVE,
              DialogType::FILE, GNEDialog::Buttons::ACCEPT_CANCEL, GNEDialog::OpenType::MODAL,
              GNEDialog::ResizeMode::RESIZABLE, 500, 300) {
    buildFileDialog(elementFile, extensions, openMode, configType, initialFolder);
}
 
 
GNEFileDialog::GNEFileDialog(GNEApplicationWindow* applicationWindow, GNEDialog* parentDialog,
                             const std::string elementFile, const std::vector<std::string>& extensions,
                             GNEFileDialog::OpenMode openMode, GNEFileDialog::ConfigType configType,
                             const std::string initialFolder) :
    GNEDialog(applicationWindow, parentDialog, TLF("Save % as", elementFile), GUIIcon::SAVE,
              DialogType::FILE, GNEDialog::Buttons::ACCEPT_CANCEL, GNEDialog::OpenType::MODAL,
              GNEDialog::ResizeMode::RESIZABLE, 500, 300) {
    buildFileDialog(elementFile, extensions, openMode, configType, initialFolder);
}
 
 
GNEFileDialog::~GNEFileDialog() {
    getApp()->reg().writeIntEntry("GNEFileDialog", "width", getWidth());
    getApp()->reg().writeIntEntry("GNEFileDialog", "height", getHeight());
    getApp()->reg().writeUnsignedEntry("GNEFileDialog", "style", myFileSelector->getFileBoxStyle());
    getApp()->reg().writeUnsignedEntry("GNEFileDialog", "showhidden", myFileSelector->showHiddenFiles());
}
 
 
void
GNEFileDialog::runInternalTest(const InternalTestStep::DialogArgument* dialogArgument) {
    if (dialogArgument->getCustomAction().size() > 0) {
        myFileSelector->setFilter(dialogArgument->getIndex());
        myFileSelector->setPath(dialogArgument->getCustomAction());
    }
}
 
 
std::string
GNEFileDialog::getFilename() const {
    return assureExtension(myFileSelector->getFilename());
}
 
 
std::vector<std::string>
GNEFileDialog::getFilenames() const {
    std::vector<std::string> filenames;
    // assure extension for each file
    for (auto& filename : myFileSelector->getFilenames()) {
        filenames.push_back(assureExtension(filename));
    }
    return filenames;
}
 
 
std::string
GNEFileDialog::getDirectory() const {
    return myFileSelector->getDirectory();
}
 
 
std::string
GNEFileDialog::assureExtension(const std::string& filename) const {
    // get group of extensions selected in comboBox
    const auto& extensions = myFileSelector->getFileExtension();
    // iterate all groups of extensions
    for (const auto& extension : extensions) {
        // iterate over all extension to check if is the same extension
        if (StringUtils::endsWith(filename, extension)) {
            return filename;
        }
    }
    // in this point, we have to give an extension (if exist)
    if (extensions.size() > 0) {
        return (filename + extensions.front());
    } else {
        return filename;
    }
}
 
 
long
GNEFileDialog::onCmdAccept(FXObject*, FXSelector, void*) {
    const FXString directory = myFileSelector->getDirectory().c_str();
    const FXString filename = myFileSelector->getFilename().c_str();
    // update current folder
    if (directory.length() > 0) {
        gCurrentFolder = directory;
    } else if (filename.length() > 0) {
        gCurrentFolder = FXPath::directory(filename);
    }
    // close dialog accepting changes
    return closeDialogAccepting();
}
 
 
void
GNEFileDialog::buildFileDialog(const std::string elementFile, const std::vector<std::string>& extensions,
                               GNEFileDialog::OpenMode openMode, GNEFileDialog::ConfigType configType,
                               const std::string initialFolder) {
    // update title and icon if we are opening
    if (openMode != GNEFileDialog::OpenMode::SAVE) {
        updateIcon(GUIIcon::OPEN);
        updateTitle(TLF("Open %", elementFile));
    }
    // create file selector
    myFileSelector = new GNEFileSelector(this, extensions, openMode, configType);
    // retarget accept button to file selector
    myAcceptButton->setTarget(myFileSelector);
    myAcceptButton->setSelector(FXFileSelector::ID_ACCEPT);
    // check if we have saved settings in registry
    setWidth(getApp()->reg().readIntEntry("GNEFileDialog", "width", getWidth()));
    setHeight(getApp()->reg().readIntEntry("GNEFileDialog", "height", getHeight()));
    myFileSelector->setFileBoxStyle(getApp()->reg().readUnsignedEntry("GNEFileDialog", "style", myFileSelector->getFileBoxStyle()));
    myFileSelector->showHiddenFiles((getApp()->reg().readUnsignedEntry("GNEFileDialog", "showhidden", myFileSelector->showHiddenFiles()) == 1) ? TRUE : FALSE);
    // set initial directory
    if (initialFolder.size() > 0) {
        myFileSelector->setDirectory(initialFolder.c_str());
    } else if (gCurrentFolder.length() > 0) {
        myFileSelector->setDirectory(gCurrentFolder);
    }
    // open dialog without focusing the button
    openDialog(myFileSelector->getFilenameTextField());
}
 
/****************************************************************************/