GNEFileSelector.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// widget used for file selection
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <utils/foxtools/fxheader.h>
 
#include "GNEFileDialog.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class MFXComboBoxIcon;
class MFXStaticToolTip;
class MFXTextFieldIcon;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEFileSelector : public FXVerticalFrame {
    FXDECLARE(GNEFileSelector)
 
public:
    GNEFileSelector(GNEFileDialog* fileDialog, const std::vector<std::string>& extensions,
                    GNEFileDialog::OpenMode openMode, GNEFileDialog::ConfigType configType);
 
    virtual ~GNEFileSelector();
 
    void setPath(const std::string& path);
 
    void setFilter(const int index);
 
    void setFilename(const FXString& path);
 
    std::string getFilename() const;
 
    std::vector<std::string> getFilenames() const;
 
    std::string getDirectory() const;
 
    const std::vector<std::string>& getFileExtension() const;
 
    void setDirectory(const FXString& path);
 
    void setItemSpace(FXint s);
 
    FXint getItemSpace() const;
 
    void setFileBoxStyle(FXuint style);
 
    FXuint getFileBoxStyle() const;
 
    void setMatchMode(FXuint mode);
 
    FXuint getMatchMode() const;
 
    FXbool showHiddenFiles() const;
 
    void showHiddenFiles(FXbool showing);
 
    FXbool showImages() const;
 
    void showImages(FXbool showing);
 
    FXint getImageSize() const;
 
    void setImageSize(FXint size);
 
    MFXTextFieldIcon* getFilenameTextField() const;
 
 
    long onCmdAccept(FXObject*, FXSelector, void*);
 
    long onCmdFilter(FXObject*, FXSelector, void*);
 
    long onCmdItemDoubleClicked(FXObject* obj, FXSelector sel, void* ptr);
 
    long onCmdItemSelected(FXObject*, FXSelector, void*);
 
    long onCmdItemDeselected(FXObject*, FXSelector, void*);
 
    long onCmdDirectoryUp(FXObject*, FXSelector, void*);
 
    long onUpdDirectoryUp(FXObject*, FXSelector, void*);
 
    long onCmdDirTree(FXObject*, FXSelector, void*);
 
    long onCmdHomeFolder(FXObject*, FXSelector, void*);
 
    long onCmdWorkFolder(FXObject*, FXSelector, void*);
 
    long onCmdConfigFolder(FXObject*, FXSelector, void*);
 
    long onCmdBookmark(FXObject*, FXSelector, void*);
 
    long onCmdVisit(FXObject*, FXSelector, void*);
 
    long onCmdNewFolder(FXObject*, FXSelector, void*);
 
    long onUpdNewFolder(FXObject*, FXSelector, void*);
 
    long onCmdMove(FXObject*, FXSelector, void*);
 
    long onCmdCopy(FXObject*, FXSelector, void*);
 
    long onCmdDelete(FXObject*, FXSelector, void*);
 
    long onUpdSelected(FXObject*, FXSelector, void*);
 
    long onPopupMenu(FXObject*, FXSelector, void*);
 
    long onCmdImageSize(FXObject*, FXSelector, void*);
 
    long onUpdImageSize(FXObject*, FXSelector, void*);
 
    long onKeyPress(FXObject* obj, FXSelector sel, void* ptr);
 
 
protected:
    FOX_CONSTRUCTOR(GNEFileSelector)
 
    
    GNEFileDialog* myFileDialog = nullptr;
 
    const GNEFileDialog::OpenMode myOpenMode = GNEFileDialog::OpenMode::SAVE;
 
    const GNEFileDialog::ConfigType myConfigType = GNEFileDialog::ConfigType::NETEDIT;
 
    FXFileList* myFileSelector = nullptr;
 
    MFXTextFieldIcon* myFilenameTextField = nullptr;
 
    MFXComboBoxIcon* myFileFilterComboBox = nullptr;
 
    FXMenuPane* myBookmarkMenuPane = nullptr;
 
    FXDirBox* myDirBox = nullptr;
 
    FXRecentFiles myBookmarksRecentFiles = nullptr;
 
    std::vector<std::vector<std::string> > myExtensions;
 
private:
    std::vector<std::string> getSelectedFiles() const;
 
    std::vector<std::string> getSelectedFilesOnly() const;
 
    void buildBookmarkMenuPane(FXHorizontalFrame* navigatorHorizontalFrame);
 
    void buildButtons(FXHorizontalFrame* navigatorHorizontalFrame, MFXStaticToolTip* staticTooltipMenu);
 
    void buildShortcuts();
 
    void parseExtensions(const std::vector<std::string>& extensions);
 
    GNEFileSelector(const GNEFileSelector&) = delete;
 
    GNEFileSelector& operator=(const GNEFileSelector&) = delete;
};
 
/****************************************************************************/